NixOS Wiki

NixOS on ARM: Difference between revisions

← Older editNewer edit →
Visual
Add Radxa ROCK 4 to table (will add linked page next)
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<!--T:1-->
<div style="font-size: 1.5rem; text-align: center;padding-bottom: 0.5rem;"><strong>NixOS supports 64-bit ARM.</strong></div>
<div style="font-size: 1.5rem; text-align: center;padding-bottom: 0.5rem;"><strong>NixOS supports 64-bit ARM.</strong></div>


<!--T:2-->
The support level for ARM overall varies depending on the architecture and the specific ecosystems and boards.
The support level for ARM overall varies depending on the architecture and the specific ecosystems and boards.


<!--T:3-->
The way the ARM integration is built into NixOS is by making '''generic builds the first-class citizens'''. This means that as soon as there is upstream support for the board in the kernel and platform firmware, NixOS should work once those are updated.
The way the ARM integration is built into NixOS is by making '''generic builds the first-class citizens'''. This means that as soon as there is upstream support for the board in the kernel and platform firmware, NixOS should work once those are updated.


<!--T:4-->
It is still possible, when needed, to build and use a customized platform firmware and kernel for specific boards<sup>[[Talk:NixOS_on_ARM#NixOS_.22support.22_for_board-specific_kernels_or_bootloaders|[reference needed]]]</sup>.
It is still possible, when needed, to build and use a customized platform firmware and kernel for specific boards<sup>[[Talk:NixOS_on_ARM#NixOS_.22support.22_for_board-specific_kernels_or_bootloaders|[reference needed]]]</sup>.


<!--T:5-->
At this moment in time (early 2024) '''only AArch64''' has full support upstream. With that said, neither armv6l or armv7l are being ignored, fixes are worked on and approved as needed. What's missing is support and builds being maintained in binary form. At the time of writing, no publicly available caches for armv6l or armv7l are available.<!-- please get in touch with samueldr on the NixOS on ARM channel if you want to share your own cache, before editing. We need to review the wording to make it crystal clear it's a user-provided cache. -->
At this moment in time (early 2024) '''only AArch64''' has full support upstream. With that said, neither armv6l or armv7l are being ignored, fixes are worked on and approved as needed. What's missing is support and builds being maintained in binary form. At the time of writing, no publicly available caches for armv6l or armv7l are available.<!-- please get in touch with samueldr on the NixOS on ARM channel if you want to share your own cache, before editing. We need to review the wording to make it crystal clear it's a user-provided cache. -->


'''For images links, including UEFI install''', skip to the [[NixOS on ARM#Installation|Installation]] section.
<!--T:6-->
'''For images links, including UEFI install''', skip to the [[NixOS_on_ARM/Installation|Installation page]].


== Supported devices ==
== Supported devices == <!--T:7-->


<!--T:8-->
Table legend:
Table legend:
* SoC - https://en.wikipedia.org/wiki/System_on_a_chip
* SoC - https://en.wikipedia.org/wiki/System_on_a_chip
* ISA - https://en.wikipedia.org/wiki/Instruction_set_architecture
* ISA - https://en.wikipedia.org/wiki/Instruction_set_architecture


=== Upstream (NixOS) supported devices ===
=== Upstream (NixOS) supported devices === <!--T:9-->


<!--T:10-->
NixOS has support for these boards using AArch64 architecture on the nixpkgs-unstable and stable channel.
NixOS has support for these boards using AArch64 architecture on the nixpkgs-unstable and stable channel.


<!--T:11-->
Support for those board assumes as much is supported as Mainline Linux supports.
Support for those board assumes as much is supported as Mainline Linux supports.
<!--
<!--
Line 56: Line 67:
=== Community supported devices ===
=== Community supported devices ===


<!--T:12-->
These boards are not routinely verified as working.
These boards are not routinely verified as working.


<!--T:13-->
The baseline support level expected is “Just as much as mainline Linux and U-Boot supports them”, except if specified otherwise.
The baseline support level expected is “Just as much as mainline Linux and U-Boot supports them”, except if specified otherwise.
<!--
<!--
Line 65: Line 78:
-->
-->
<div class="table">
<div class="table">
{|class="table"
{| class="sortable table"
!width="2%"| Manufacturer
!width="2%"| Manufacturer
!width="2%"| Board
!width="2%"| Board
Line 83: Line 96:
|-
|-
| ASUS
| ASUS
| [[NixOS_on_ARM/Tinker Board|Tinker Board]]
| [[NixOS_on_ARM/ASUS Tinker Board|Tinker Board]]
| Rockchip RK3288
| Rockchip RK3288
| ARMv7
| ARMv7
Line 101: Line 114:
| [[NixOS_on_ARM/Banana Pi M64|Banana Pi M64]]
| [[NixOS_on_ARM/Banana Pi M64|Banana Pi M64]]
| Allwinner A64
| Allwinner A64
| ARMv8
| AArch64
| 4× Cortex-A53
| 4× Cortex-A53
| 2 GB
| 2 GB
Line 109: Line 122:
| [[NixOS_on_ARM/Banana Pi BPI-M5|Banana Pi BPI-M5]]
| [[NixOS_on_ARM/Banana Pi BPI-M5|Banana Pi BPI-M5]]
| Amlogic S905X3
| Amlogic S905X3
| ARMv8.2
| AArch64
| 4× Cortex-A55
| 4× Cortex-A55
| 4 GB LPDDR4
| 4 GB LPDDR4
Line 353: Line 366:
| 4 GB
| 4 GB
| microSD
| microSD
|-
| Radxa
| [[NixOS on ARM/Radxa ROCK 4|ROCK 4]]
| Rockchip RK3399
| AArch64
| 2× Cortex-A72, 4×Cortex-A53
| 2/4 GB
| eMMC, microSD, NVMe via expansion board
|-
|-
| Radxa
| Radxa
Line 428: Line 449:
</div>
</div>


==== Special Devices ====
==== Special Devices ==== <!--T:14-->


<!--T:15-->
It is possible to emulate an ARM platform with QEMU.
It is possible to emulate an ARM platform with QEMU.


<!--T:16-->
<div class="table">
<div class="table">
{|class="table"
{|class="table"
Line 452: Line 475:
</div>
</div>


== Installation ==
== Installation == <!--T:17-->


<!--T:18-->
{{main|NixOS_on_ARM/Installation}}
{{main|NixOS_on_ARM/Installation}}


== Binary caches ==
== Initial configuration == <!--T:19-->
 
=== AArch64 ===
 
The [https://hydra.nixos.org/ official NixOS Hydra] instance builds a full set of binaries (available on https://cache.nixos.org) for the AArch64 architecture on the nixpkgs-unstable and stable channels.
 
=== armv6l and armv7l ===
 
Some '''''users''''' have provided best effort caches for 32 bit ARM, but none are currently available.
 
== Enable UART ==
 
If you try to use UART to log on NixOS, you might hang on the line "Starting kernel ...". To enable UART, you will need to add at the end of the line that contains <code>loglevel4</code> in the file <code>/extlinux/extlinux.conf</code> the text:
{{file|/extlinux/extlinux.conf||<nowiki>
    console=ttyAMA0,115200n8
</nowiki>}}
{{file|/extlinux/extlinux.conf||<nowiki>
    console=ttyS0,115200n8
</nowiki>}}
The actual device (<code>ttyAMA0</code>, <code>ttyS0</code>, <code>ttyS1</code>) will depend on the hardware.
 
== NixOS installation & configuration ==


<!--T:20-->
{{main|NixOS_on_ARM/Initial_Configuration}}
{{main|NixOS_on_ARM/Initial_Configuration}}


== Details about the boot process ==
== Troubleshooting == <!--T:21-->


NixOS can be booted through [[NixOS on ARM/UEFI|UEFI]] on ARM too. The semantics are generally the same as on other architectures. Do note that the common use of Device Tree instead of ACPI in consumer-class hardware ''may'' make this a bit more awkward.
<!--T:22-->
=== Hanging at <code>Starting kernel ...</code> ===
When booting a NixOS system, it may look like it is hung at <code>Starting kernel ...</code>.


Otherwise, in SBC-class hardware, it is common that boards are generally expected to use U-Boot as the platform firmware and bootloader. See the section about [[U-Boot#Using NixOS with U-Boot|using NixOS with U-Boot]].  
<!--T:23-->
It is unlikely to be hung at this part. This is the last message printed by U-Boot. U-Boot prints to both the display and the console at once.


== Porting NixOS to new boards ==
<!--T:24-->
To view the kernel messages and boot output, the “<code>stdout</code>” of the kernel needs to be configured appropriately.


=== The easiest way ===
<!--T:25-->
The kernel's <code>stdout</code> will differ depending on semantics.


Assuming upstream U-Boot supports the board through a defconfig, it is possible possible to build U-Boot using the cross-compiling architecture from an x86_64 host. Here's a sample use.
<!--T:26-->
* When there are no valid <code>console=</code> kernel command-line arguments, it will default to the <code>/chosen/stdout-path</code> device tree property. (Generally a serial console.)
* When valid <code>console=</code> parameters are present, the kernel picks the leftmost valid one as <code>stdout</code>.


<syntaxhighlight lang="shell-session">
<!--T:27-->
# Assuming you're in a recent nixpkgs checkout
In other words, the solution may be to enable the appropriate <code>console=</code> parameters according to your hardware configuration and system.
$ nix-shell \
    -I "nixpkgs=$PWD" \
    -p 'let plat = pkgsCross.aarch64-multiplatform; in plat.buildUBoot{defconfig = "orangepi_zero_plus2_defconfig"; extraMeta.platforms = ["aarch64-linux"]; BL31 = "${plat.armTrustedFirmwareAllwinner}/bl31.bin"; filesToInstall = ["u-boot-sunxi-with-spl.bin"];}'
</syntaxhighlight>


For armv7 and armv6 <code>pkgsCross.arm-embedded</code> should work, this is available in the unstable channel (19.03 and following) by setting <code>-I "nixpkgs=/path/to/new-nixpkgs-checkout</code>.
<!--T:28-->
* For the display, add <code>console=tty0</code>.
* For a serial console, refer to the target device configuration.


This should build whatever is needed for, and then build U-Boot for the desired defconfig, then open a shell with the build in <code>$buildInputs</code>. Do note that this particular invocation may need more changes than only the defconfig if built for other than allwinner boards.
=== Details about the boot process === <!--T:29-->


Here's an example command, for allwinner boards, on how to write to an SD card.
<!--T:30-->
NixOS can also be booted through [[NixOS on ARM/UEFI|UEFI]] on ARM. The semantics are generally the same as on other architectures. Do note that the common use of Device Tree instead of ACPI in consumer-class hardware [[NixOS_on_ARM/UEFI#Device_Trees|''may'' make this a bit more awkward]].


<syntaxhighlight lang="shell-session">
<!--T:31-->
$ sudo dd if=$buildInputs/u-boot-sunxi-with-spl.bin of=/dev/sdX bs=1024 seek=8
Otherwise, in SBC-class hardware, it is common that boards are generally expected to use U-Boot as the platform firmware and bootloader. See the section about [[U-Boot#Using NixOS with U-Boot|using NixOS with U-Boot]].
</syntaxhighlight>


=== The easy way ===
== Binary caches == <!--T:32-->


''(if you're lucky)''
=== AArch64 === <!--T:33-->


If your board is an ARMv7 board supported by multi_v7_defconfig and you have access to U-Boot on the board, getting <code>sd-image-armv7l-linux.img</code> to boot is the easiest option:
<!--T:34-->
 
The [https://hydra.nixos.org/ official NixOS Hydra] instance builds a full set of binaries (available on https://cache.nixos.org) for the AArch64 architecture on the nixpkgs-unstable and stable channels.
* If you're lucky and your U-Boot build comes with the extlinux.conf support built in, the image boots out-of-the-box. This is the case for all (upstream) Allwinner and Tegra U-Boots, for instance.
* Otherwise, you can get the boot information (path to kernel zImage, initrd, DTB, command line arguments) by extracting <code>extlinux.conf</code> from the boot partition of the image, and then attempt to boot it via the U-Boot shell, or some other mechanism that your board's distro uses (e.g. <code>uEnv.txt</code>).
 
==== Building U-Boot from your NixOS PC ====
 
Assuming
 
* Your board is supported upstream by U-Boot or there is a recent enough fork with <code>extlinux.conf</code> support.
* You do not have nix setup on an ARM device
* Your nix isn't setup for cross-compilation
 
It is still possible to build U-Boot using tools provided by NixOS.
 
In the following terminal session, replace <code>orangepi_pc_defconfig</code> with the appropriate board [http://git.denx.de/?p=u-boot.git;a=tree;f=configs;hb=HEAD from the configs folder] of U-Boot.
 
{{Commands|<nowiki>
$ nix-shell -E 'with import <nixpkgs> {}; stdenv.mkDerivation { name = "arm-shell"; buildInputs = [git gnumake gcc gcc-arm-embedded dtc]; }'
$ git clone git://git.denx.de/u-boot.git
$ cd u-boot
# We're checking out a version from before the use of `binman`.
# The dtc package is 1.4.2, which does not include `pylibftd`.
# Furthermore, I do not know how to package the library so it would be
# available in the python interpreter, making binman happy.
$ git checkout v2017.03
$ make -j4 CROSS_COMPILE=arm-none-eabi- orangepi_pc_defconfig
$ make -j4 CROSS_COMPILE=arm-none-eabi-
</nowiki>}}
 
The name of the final file will change depending on the board. For this specific build, and most Allwinner builds, the file will be named <code>u-boot-sunxi-with-spl.bin</code>.
 
You can flash this file to boot device with
 
{{Commands|<nowiki>
dd if=u-boot-sunxi-with-spl.bin of=/dev/sdX bs=1024 seek=8
</nowiki>}}
 
Note: This mailing list contains a patch which may help some builds: https://lists.denx.de/pipermail/u-boot/2016-December/275664.html
 
=== The hard way ===
 
Alternatively/if all else fails, you can do it the hard way and bootstrap NixOS from an existing ARM Linux installation.


=== Contributing new boards to nixpkgs ===
=== armv6l and armv7l === <!--T:35-->


* Add a new derivation for your board's U-Boot configuration, see for example ubootPine64LTS in {{Nixpkgs Link|short=all-packages.nix|pkgs/top-level/all-packages.nix}}.
<!--T:36-->
* If your board's U-Boot configuration doesn't use the <code>extlinux.conf</code> format by default, create a patch to enable it. Some C hacking skills & U-Boot knowledge might be required. For some pointers, see this patch to enable it on the Versatile Express.
Some '''''users''''' have provided best effort caches in the past for 32 bit ARM, but none are currently available.
* Make a pull request, also containing the board-specific instructions.


== Getting Support ==
== Getting Support == <!--T:37-->


<!--T:38-->
There is a dedicated room for the upstream NixOS effort on Matrix,  
There is a dedicated room for the upstream NixOS effort on Matrix,  
[https://matrix.to/#/#nixos-on-arm:nixos.org #nixos-on-arm:nixos.org].
[https://matrix.to/#/#nixos-on-arm:nixos.org #nixos-on-arm:nixos.org].


<!--T:39-->
Don't hesitate to ask questions. Note that reply times may vary greatly, depending on the provided information.
Don't hesitate to ask questions. Note that reply times may vary greatly, depending on the provided information.


== Resources ==
== Resources == <!--T:40-->


=== See also ===
=== See also === <!--T:41-->


<!--T:42-->
* [[U-Boot]], as it is often paired with SBC-class hardware.
* [[U-Boot]], as it is often paired with SBC-class hardware.
* [https://mobile.nixos.org/ Mobile NixOS], which provides enhanced semantic around some non-standard boot semantics.
* [https://mobile.nixos.org/ Mobile NixOS], which provides enhanced semantic around some non-standard boot semantics.


=== Subpages ===
=== Subpages === <!--T:43-->


<!--T:44-->
The following is a list of all sub-pages of the ''NixOS on ARM'' topic.
The following is a list of all sub-pages of the ''NixOS on ARM'' topic.


<!--T:45-->
{{Special:PrefixIndex/{{FULLPAGENAME}}/ |hideredirects=1 |stripprefix=1}}
{{Special:PrefixIndex/{{FULLPAGENAME}}/ |hideredirects=1 |stripprefix=1}}
</translate>
Retrieved from "https://wiki.nixos.org/wiki/NixOS_on_ARM"