NixOS on ARM/OLIMEX Teres-A64: Difference between revisions

From NixOS Wiki
imported>KREYREN
Added more informations on the workaround for broken kernel
imported>KREYREN
HDMI seems to work
 
(12 intermediate revisions by the same user not shown)
Line 29: Line 29:
== Status ==
== Status ==


Work In Progress..
Stable, production-ready and suitable for mission critical environment


The system is bootable and seems to work, but audio is broken and has issues with graphical issues that are currently being investigated, note known issues below for building on Linux 6.0~6.1 resulting in broken display.
For U-Boot use armbian's distribution as currently the nixos's version is outdated and broken
 
U-boot support [https://github.com/NixOS/nixpkgs/pull/240827 has been submitted on 2023-06-30, but not yet merged].


== Installation instructions ==
== Installation instructions ==


{{ARM/installation allwinner|variant=aarch64}}
=== UEFI (recommended) ===


=== Partitioning ===
{{note|This method assumes that you have your bootloader flashed in eMMC or SPI}}


All Allwinner SoCs will try to find a boot image at sector 16 (8KB) of an SD card, connected to the first MMC controller.[3]  
Refer to the nixos.org download page and download the installer to your preference, then proceed to follow instructions in the [https://nixos.org/manual/nixos/stable/ NixOS manual on how to flash the installer] on e.g. USB drive


{{expansion|Details yet to be written..}}
=== EXTLINUX (legacy) ===


==== MBR partition scheme ====
{{ARM/installation allwinner|variant=aarch64}}


{{expansion|Installation instructions need to be written up to keep space for embedding the bootloader to the SPL.}}
== Serial console==


==== GPT partition scheme ====
Serial console can be accessed by default on BAUM 115200 using the [https://www.olimex.com/Products/DIY-Laptop/KITS/TERES-USB-DEBUG/ TERES-USB-DEBUG] cable (or make one it's 3 pole jack with pl2303 converter, can be made work off of single board computer, etc..) in headphone jack port and accessed through:


The [[NixOS_on_ARM/Allwinner_GPT_Installation|Allwinner GPT Installation]] instruction explains how to create a GPT partition table while allowing the isntallation of u-boot at the required offset.
    $ picocom -b BAUD /dev/SERIAL-DEVICE # Often set as /dev/ttyUSB0 @ baud of 115200


== Serial console==
Currently the sdcard has set this by fault, but if you use custom configuration and want to maintain the serial console functionality then you need to append it to the kernel CLI through:


{{expansion|Details yet to be written..}}
    boot.kernelParams = ["console=ttyS0,115200n8"];


== Compatibility notes ==
== Compatibility notes ==


{| class="table arm-compatibility"
{| class="table arm-compatibility"
!colspan="2" style="background: #fafafa"| Mainline kernel
!colspan="2" style="background: #fafafa"| Mainline kernel on NixOS
|-
|-
! HDMI
! HDMI
|
|
* Hasn't been tested.
* Works
|-
! Display
|
* Expected to work without issues with exceptions, see sunxi wiki
|-
! WiFi/Bluetooth
|
* Works, currently requires non-libre firmware for RTL8723BS which is projected to be mitigated
|-
! Audio (reproductors)
|
* Unknown
|-
! Audio (audio jack)
|
* Unknown
|-
! 3D Acceleration
|
* Works
|-
! Webcam
|
* Unknown
|-
! Touchpad
|
* Works
|-
! Keyboard
|
* Works
|-
! SdCard reader
|
* Works
|-
! FOSS Bootloader
|
* Works - U-Boot/TowBoot
|}
|}


=== Downstream kernel ===
=== Kernels ===
 
==== Downstream Kernel ====


{{note|Keep in mind that using non-upstream forks of the kernel always incurs some risk as far as security goes.}}
{{note|Keep in mind that using non-upstream forks of the kernel always incurs some risk as far as security goes.}}
Line 73: Line 113:
{{expansion|Find and document use of a kernel with the added capabilities.}}
{{expansion|Find and document use of a kernel with the added capabilities.}}


== USB booting with u-boot ==
== USB booting with U-Boot ==


You will need to either have mainline U-Boot installed to the eMMC or to an SD card.
You will need to either have mainline U-Boot installed to the eMMC or to an SD card.
Line 87: Line 127:
This sets the boot order for this boot only. U-Boot can boot (among others) either of the NixOS sd-image or EFI iso from USB.
This sets the boot order for this boot only. U-Boot can boot (among others) either of the NixOS sd-image or EFI iso from USB.


== Known issues ==
== Notes ==


Building the bootloader and the configuration on linux 6.0~6.1 will result in broken display rendering due to  "''DRM_IOCTL_MODE_CREATE_DUMB failed: Cannot allocate memory''' caused by insufficient Quality Assurance at mesa upstream tracked on https://gitlab.freedesktop.org/mesa/mesa/-/issues/8198.
Refer to the device's sunxi-linux wiki page for more details: https://linux-sunxi.org/Olimex_Teres-A64


The fix has been merged in https://gitlab.freedesktop.org/mesa/mesa/-/commit/c426e5677f36c3b0b8e8ea199ed4f2c7fad06d47 and is part of Linux 6.2 so as long as you build ""and use"" this kernel the display should work without an issue.
For u-boot installation refer to the u-boot documentation for AllWinner devices: https://docs.u-boot.org/en/stable/board/allwinner/sunxi.html#installing-on-a-micro-sd-card


Note that if you boot and build on broken kernel then you can use serial console on BAUM 115200 to fix the issue.
For TowBoot installation refer to the TowBoot wiki:


As of 03/07/2023-EU NixOS 23.05 is shipped with LTS kernel which is 6.1 to get non-broken kernel you can use the following configuration:
== Resources ==
 
<pre>
# configuration.nix
boot.kernelPackages = pkgs.linuxPackages_6_3;
</pre>
 
Please let me know if you encounter this issue outside of known broken linux release. -- KREYREN


== Resources ==
0. [https://linux-sunxi.org/Olimex_Teres-A64 The Sunxi Linux Wiki Page for the device]


1. [https://www.olimex.com/Products/DIY-Laptop/ Official product page]
1. [https://www.olimex.com/Products/DIY-Laptop/ Official product page]
Line 113: Line 146:


4. [https://www.armbian.com/olimex-teres-a64 Armbian product page for Teres]
4. [https://www.armbian.com/olimex-teres-a64 Armbian product page for Teres]
5. [https://www.olimex.com/forum/index.php?board=39.0 Teres-A64 section on the OLIMEX forum]

Latest revision as of 10:05, 6 February 2024

OLIMEX Teres-A64
The King Himself
Manufacturer OLIMEX, Ltd
Architecture AArch64
Bootloader Upstream U-Boot[1]
Boot order SD, eMMC
Maintainer KREYREN

Teres-1 (often referred as teres-a64) is an open-source hardware and software netbook design based on the Allwinner A64 SoC.

It can boot from SD or from the included and slow af eMMC module (insane people use only).

Status

Stable, production-ready and suitable for mission critical environment

For U-Boot use armbian's distribution as currently the nixos's version is outdated and broken

Installation instructions

UEFI (recommended)

Note: This method assumes that you have your bootloader flashed in eMMC or SPI

Refer to the nixos.org download page and download the installer to your preference, then proceed to follow instructions in the NixOS manual on how to flash the installer on e.g. USB drive

EXTLINUX (legacy)

To use the generic installation image for your board, you will need to copy it verbatim to an SD card.

sudo dd if=sd-image-aarch64-linux.img of=/dev/DEVICE conv=sync status=progress

This board requires the installation of u-boot at a specific location on the storage where NixOS was written to.

sudo dd if=u-boot-sunxi-with-spl.bin of=/dev/DEVICE bs=1024 seek=8

Serial console

Serial console can be accessed by default on BAUM 115200 using the TERES-USB-DEBUG cable (or make one it's 3 pole jack with pl2303 converter, can be made work off of single board computer, etc..) in headphone jack port and accessed through:

   $ picocom -b BAUD /dev/SERIAL-DEVICE # Often set as /dev/ttyUSB0 @ baud of 115200

Currently the sdcard has set this by fault, but if you use custom configuration and want to maintain the serial console functionality then you need to append it to the kernel CLI through:

   boot.kernelParams = ["console=ttyS0,115200n8"];

Compatibility notes

Mainline kernel on NixOS
HDMI
  • Works
Display
  • Expected to work without issues with exceptions, see sunxi wiki
WiFi/Bluetooth
  • Works, currently requires non-libre firmware for RTL8723BS which is projected to be mitigated
Audio (reproductors)
  • Unknown
Audio (audio jack)
  • Unknown
3D Acceleration
  • Works
Webcam
  • Unknown
Touchpad
  • Works
Keyboard
  • Works
SdCard reader
  • Works
FOSS Bootloader
  • Works - U-Boot/TowBoot

Kernels

Downstream Kernel

Note: Keep in mind that using non-upstream forks of the kernel always incurs some risk as far as security goes.

USB booting with U-Boot

You will need to either have mainline U-Boot installed to the eMMC or to an SD card.

Stop the boot process when prompted (by pressing a key). Then, do the following:

Hit any key to stop autoboot:  0
=> setenv boot_targets usb0
=> boot

This sets the boot order for this boot only. U-Boot can boot (among others) either of the NixOS sd-image or EFI iso from USB.

Notes

Refer to the device's sunxi-linux wiki page for more details: https://linux-sunxi.org/Olimex_Teres-A64

For u-boot installation refer to the u-boot documentation for AllWinner devices: https://docs.u-boot.org/en/stable/board/allwinner/sunxi.html#installing-on-a-micro-sd-card

For TowBoot installation refer to the TowBoot wiki:

Resources

0. The Sunxi Linux Wiki Page for the device

1. Official product page

2. linux-sunxi wiki page

3. U-Boot documentation for the SoC

4. Armbian product page for Teres

5. Teres-A64 section on the OLIMEX forum