Differences between revisions 1 and 37 (spanning 36 versions)
Revision 1 as of 2018-04-03 10:54:05
Size: 4987
Editor: ?HaraldGeyer
Comment: create page and add introduction
Revision 37 as of 2018-10-08 10:42:27
Size: 11557
Comment: Rephrase to not be personal.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from InstallingDebianOn/Teres
Line 14: Line 15:
<<TableOfContents()>>
Line 15: Line 18:
The Teres-I is a DIY open hardware laptop sold by Olimex. Olimex has stated that they intend the Teres-I to be very modular, allowing main boards built around different !SoCs interchangeably. However the only main board available at the moment is based on the Allwinner A64 SoC with 2GB RAM and 16GB eMMC internal storage. The CPU is supported by the arm64 architecture in debian. armhf should work too, but is untested.

The laptop is sold with linux (ubuntu + vendor supplied kernel) preinstalled. There is not full source code available for the vendor kernel, which means that users of the preinstalled system are permanently stuck with an old version of linux. On the other hand since a linux system is available no external computer and no cross-compilation is required to bootstrap a debian system.

While debian should run fine from the eMMC internal storage, most people install debian to an external microSD card (there is one slot available) to have both systems available. That's also what is described in this guide.
The Teres-I is a DIY open hardware laptop sold by Olimex.
Olimex has stated that they intend the Teres-I to be very modular,
allowing main boards built around different !SoCs to be used interchangeably.
However the only main board available at the moment is based on the Allwinner A64 SoC
with 2GB RAM and 16GB eMMC internal storage.
The CPU is supported by the arm64 architecture in debian.
armhf should work too, but is untested.

The laptop is sold with linux (ubuntu + vendor supplied kernel) preinstalled.
Source code is only partially available
for the vendor kernel,
which means that users of the preinstalled system are permanently stuck with an old version of linux.
On the other hand since a linux system is available,
no external computer and no cross-compilation is required to bootstrap a debian system.

While debian should run fine from the eMMC internal storage,
most people install debian to an external microSD card (there is one slot available)
to have both systems available.
That's also what is described in this guide.
Line 22: Line 38:
To get an overview of mainline kernel support,
see the [[http://linux-sunxi.org/Linux_mainlining_effort#Status_Matrix|status matrix of the linux sunxi community]].
Line 25: Line 44:
||Boot Standard Kernel: || [OK] ||
|| Detect mmc: || [OK] ||
||Boot Standard Kernel: || {OK} - since Buster ||
|| Detect mmc: || {OK} ||
Line 29: Line 48:
|| CPU Frequency Scaling || [X] || || CPU Frequency Scaling || {X} ||
Line 31: Line 50:
|| Sleep / Suspend || [!] ||
|| Xorg || [OK] ||
|| Sleep / Suspend || {OK} - only with experimental kernel (requires Linux 4.19) ||
|| Xorg || {OK} ||
Line 35: Line 54:
|| Switch to External Screen || [X] || || Switch to External Screen || {X} ||
Line 37: Line 56:
|| - Built-in (Touchpad) || [OK] ||
|| Wireless/Wifi || [X-] ||
|| - Built-in (Touchpad) || {OK} ||
|| Wireless/Wifi || X-( ||
Line 40: Line 59:
~-Legend :<<BR>> {OK} = OK ; {X} Unsupported(No Driver) ; /!\ = Error (Couldn't get it working); [?] Unknown, Not Test ; [-] Not-applicable <<BR>> {i} = Configuration Required; X-( = Only works with a non-free driver and or firmware-~
~-Legend :<<BR>>
{OK} = OK ;
{X} Unsupported(No Driver) ;
/!\ = Error (Couldn't get it working);
[?] Unknown, Not Test ;
[-] Not-applicable <<BR>>
{i} = Configuration Required;
X-( = Only works with a non-free driver and or firmware-~

= Installation =
The laptop is sold as a kit for self-assembly.
Here we assume that it is completely assembled
and confirmed working correctly with the preinstalled system.

== Image install ==

Several images exist for directly writing to your microSD card:

## sorted by distance to debian - e.g. add official installer images at the top
 * [[https://box.redpill.dk/core_with_quirks/|Redpill]]
  * Source: Debian
  * Build: Boxer + qemu + multistrap + [[http://source.homebase.dk/box.git|custom scripts]]
  * Quirks: No bootloader (download separately). Includes nonfree package firmware-realtek.
 * [[https://www.armbian.com/olimex-teres-a64/|Armbian]]
  * Source: Debian (or Ubuntu) + Armbian + Armbian-maintained forks of kernel and bootloader
  * Build: debootstrap + [[https://github.com/igorpecovnik/lib|custom scripts]]
 * [[https://www.olimex.com/wiki/images/1/15/Teres1_20171211-v1.3.torrent|Olimex (torrent link)]]
  * Source: Ubuntu + Olimex + Olimex-maintained forks of kernel and bootloader
  * Build: qemu-debootstrap + [[https://github.com/OLIMEX/DIY-LAPTOP|custom scripts]]

For links, further information and discussion
see the [[https://www.olimex.com/forum/index.php?topic=6092.0|dedicated thread at the olimex forum]].

== Manual install ==
Buster and newer include kernel and arm64 userspace tools working out of the box,
but you will need to get or compile yourself a custom bootloader.

=== partitioning ===
There are no real requirements for disk layout
other than that the bootloader is stored in an area close to the start of the disk but outside any partition.
Most microSD cards already come with a compatible partition layout,
so you only have to change the type of the existing partition from Windows to Linux
and format it with your favorite filesystem.

=== device tree ===

Buster and newer ships with working device-tree (DT) file for the teres.

=== arm trusted firmware ===

Stage 2 of bootstrapping the hardware is ARM Trusted Firmware.

The debian package [[https://packages.debian.org/sid/atf-allwinner|atf-allwinner]] has support for Teres I
using this binary:{{{
/usr/lib/atf/sun50iw1p1/bl31.bin
}}}

=== u-boot ===

Stage 1 and 3 of bootstrapping the hardware is U-boot.

mainline u-boot still misses a few bits
like a pwm driver (to get display backlight up early)
and a usb driver (to read linux and initramfs from sdcard),
so you need to get this [[https://github.com/anarsoul/u-boot-pine64/commits/pinebook-wip-20180206|fork]]
and then cherry-pick one more [[https://github.com/Icenowy/u-boot/commit/960ae79950a2b0a8d2e62bb3dfb5727764512a8b|commit]]:

{{{
git clone https://github.com/anarsoul/u-boot-pine64.git
cd u-boot-pine64
git remote add icenowy https://github.com/Icenowy/u-boot/
git fetch icenowy
git checkout -b teres origin/pinebook-wip-20180206
git cherry-pick icenowy/teres-i-mainline
}}}

(possibly (untested!) all relevant changes from anarsoul's fork are merged in u-boot 2018.09,
and only patch needed since then in the one from icenowy actually adding teres-i support.)

You find information about compiling u-boot
and writing the binaries to media in board/sunxi/README.sunxi64 -
the basic steps are:

{{{
BL31=/usr/lib/atf/sun50iw1p1/bl31.bin make teres_i_defconfig
BL31=/usr/lib/atf/sun50iw1p1/bl31.bin make
dd if=spl/sunxi-spl.bin of=/dev/sdx bs=8k seek=1
dd if=u-boot.itb of=/dev/sdx bs=8k seek=5
}}}

The final files can also be downloaded:
 * [[http://friends.ccbib.org/harald/files/sunxi-spl.bin]]
 * [[http://friends.ccbib.org/harald/files/u-boot.itb]]

Possibly the U-boot parts of [[https://github.com/armbian/build/commit/03199b3|this Armbian patchset]] is relevant...

=== rootfs ===
Since there is already an ubuntu system preinstalled on the teres,
you can simple download [[https://packages.debian.org/sid/all/debootstrap/download|debootstrap from unstable]]
and install it on ubuntu -
 it's only a shell script, so no dependency problems.

Then just follow the debootstrap chapter
in the [[https://www.debian.org/releases/stable/arm64/apds03.html.en|installation manual]].

The default bootscript built into u-boot probably won't find all the files necessary to boot the system.
To fix this we need to write a custom bootscript
and reformat it with mkimage from the package u-boot-tools:
{{{
mkimage -T script -d boot.txt /boot.scr
}}}

Here is a minimal [[attachment:boot.txt|example bootscript]]
which assumes that /dtb, /vmlinuz and /initrd.gz are symlinks to the real files.

== Using debian installer ==
There is no support in the official installer yet.
However it might be possible to copy the arm64 installer files and a suitable device tree file onto a microSD card
with a bootloader from external sources.
If you try that approach, please share your experience.

== Troubleshooting ==
If the screen remains blank or the system doesn't boot (is stuck in u-boot or initramfs)
you can connect a serial console.
The serial console is multiplexed with the headphone output.
Instructions how to make or buy a proper connector are at the olimex forum.
Line 60: Line 203:
== Mouse ==
 (not covered yet)
Line 64: Line 204:
## Have you tested Hibernation and/or
## Then explain how to get it working
 (not covered yet)
Sleep is supported since Linux 4.19.
Line 69: Line 207:
 (not covered yet)

== Modem ==
Line 84: Line 219:
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
  bDeviceClass 9 Hub
  bDeviceProtocol 0 Full speed (or root) hub
  iProduct 2 Generic Platform OHCI controller
Bus 001 Device 005: ID 15ba:003c Olimex Ltd.
  bDeviceClass 0 (Defined at Interface level)
  bDeviceProtocol 0
  iProduct 2 TERES Keyboard+Touchpad
  (Bus Powered)
Bus 001 Device 003: ID 1908:2311 GEMBIRD
  bDeviceClass 239 Miscellaneous Device
  bDeviceProtocol 1 Interface Association
  iProduct 2 USB2.0 PC CAMERA
      (Bus Powered)
  bDeviceClass 239 Miscellaneous Device
  bDeviceProtocol 1 Interface Association
  (Bus Powered)
Bus 001 Device 002: ID 05e3:0608 Genesys Logic, Inc. Hub
  bDeviceClass 9 Hub
  bDeviceProtocol 1 Single TT
  iProduct 1 USB2.0 Hub
  bDeviceClass 9 Hub
  bDeviceProtocol 0 Full speed (or root) hub
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
  bDeviceClass 9 Hub
  bDeviceProtocol 0 Full speed (or root) hub
  iProduct 2 EHCI Host Controller

Translation(s): none

DebianOn is an effort to document how to install, configure and use Debian on some specific hardware. Therefore potential buyers would know if that hardware is supported and owners would know how get the best out of that hardware.

The purpose is not to duplicate the Debian Official Documentation, but to document how to install Debian on some specific hardware.

If you need help to get Debian running on your hardware, please have a look at our user support channels where you may find specific channels (mailing list, IRC channel) dedicated to certain types of hardware.

Introduction

The Teres-I is a DIY open hardware laptop sold by Olimex. Olimex has stated that they intend the Teres-I to be very modular, allowing main boards built around different SoCs to be used interchangeably. However the only main board available at the moment is based on the Allwinner A64 SoC with 2GB RAM and 16GB eMMC internal storage. The CPU is supported by the arm64 architecture in debian. armhf should work too, but is untested.

The laptop is sold with linux (ubuntu + vendor supplied kernel) preinstalled. Source code is only partially available for the vendor kernel, which means that users of the preinstalled system are permanently stuck with an old version of linux. On the other hand since a linux system is available, no external computer and no cross-compilation is required to bootstrap a debian system.

While debian should run fine from the eMMC internal storage, most people install debian to an external microSD card (there is one slot available) to have both systems available. That's also what is described in this guide.

Overall Status

To get an overview of mainline kernel support, see the status matrix of the linux sunxi community.

Core Components

[ATTACH]

Boot Standard Kernel:

{OK} - since Buster

Detect mmc:

{OK}

Extra Features

CPU Frequency Scaling

{X}

Hibernation

[?]

Sleep / Suspend

{OK} - only with experimental kernel (requires Linux 4.19)

Xorg

{OK}

- OpenGL

[?]

- Resize-and-Rotate(randr)

[?]

Switch to External Screen

{X}

Mouse

- Built-in (Touchpad)

{OK}

Wireless/Wifi

X-(

Keyboard's Hotkeys

[?]

Legend :
{OK} = OK ; {X} Unsupported(No Driver) ; /!\ = Error (Couldn't get it working); [?] Unknown, Not Test ; [-] Not-applicable
{i} = Configuration Required; X-( = Only works with a non-free driver and or firmware

Installation

The laptop is sold as a kit for self-assembly. Here we assume that it is completely assembled and confirmed working correctly with the preinstalled system.

Image install

Several images exist for directly writing to your microSD card:

  • Redpill

    • Source: Debian
    • Build: Boxer + qemu + multistrap + custom scripts

    • Quirks: No bootloader (download separately). Includes nonfree package firmware-realtek.
  • Armbian

    • Source: Debian (or Ubuntu) + Armbian + Armbian-maintained forks of kernel and bootloader
    • Build: debootstrap + custom scripts

  • Olimex (torrent link)

    • Source: Ubuntu + Olimex + Olimex-maintained forks of kernel and bootloader
    • Build: qemu-debootstrap + custom scripts

For links, further information and discussion see the dedicated thread at the olimex forum.

Manual install

Buster and newer include kernel and arm64 userspace tools working out of the box, but you will need to get or compile yourself a custom bootloader.

partitioning

There are no real requirements for disk layout other than that the bootloader is stored in an area close to the start of the disk but outside any partition. Most microSD cards already come with a compatible partition layout, so you only have to change the type of the existing partition from Windows to Linux and format it with your favorite filesystem.

device tree

Buster and newer ships with working device-tree (DT) file for the teres.

arm trusted firmware

Stage 2 of bootstrapping the hardware is ARM Trusted Firmware.

The debian package atf-allwinner has support for Teres I using this binary:

/usr/lib/atf/sun50iw1p1/bl31.bin

u-boot

Stage 1 and 3 of bootstrapping the hardware is U-boot.

mainline u-boot still misses a few bits like a pwm driver (to get display backlight up early) and a usb driver (to read linux and initramfs from sdcard), so you need to get this fork and then cherry-pick one more commit:

git clone https://github.com/anarsoul/u-boot-pine64.git
cd u-boot-pine64
git remote add icenowy https://github.com/Icenowy/u-boot/
git fetch icenowy
git checkout -b teres origin/pinebook-wip-20180206
git cherry-pick icenowy/teres-i-mainline

(possibly (untested!) all relevant changes from anarsoul's fork are merged in u-boot 2018.09, and only patch needed since then in the one from icenowy actually adding teres-i support.)

You find information about compiling u-boot and writing the binaries to media in board/sunxi/README.sunxi64 - the basic steps are:

BL31=/usr/lib/atf/sun50iw1p1/bl31.bin make teres_i_defconfig
BL31=/usr/lib/atf/sun50iw1p1/bl31.bin make
dd if=spl/sunxi-spl.bin of=/dev/sdx bs=8k seek=1
dd if=u-boot.itb of=/dev/sdx bs=8k seek=5

The final files can also be downloaded:

Possibly the U-boot parts of this Armbian patchset is relevant...

rootfs

Since there is already an ubuntu system preinstalled on the teres, you can simple download debootstrap from unstable and install it on ubuntu -

  • it's only a shell script, so no dependency problems.

Then just follow the debootstrap chapter in the installation manual.

The default bootscript built into u-boot probably won't find all the files necessary to boot the system. To fix this we need to write a custom bootscript and reformat it with mkimage from the package u-boot-tools:

mkimage -T script -d boot.txt /boot.scr

Here is a minimal example bootscript which assumes that /dtb, /vmlinuz and /initrd.gz are symlinks to the real files.

Using debian installer

There is no support in the official installer yet. However it might be possible to copy the arm64 installer files and a suitable device tree file onto a microSD card with a bootloader from external sources. If you try that approach, please share your experience.

Troubleshooting

If the screen remains blank or the system doesn't boot (is stuck in u-boot or initramfs) you can connect a serial console. The serial console is multiplexed with the headphone output. Instructions how to make or buy a proper connector are at the olimex forum.

Configuration

Display

  • (not covered yet)

Audio

  • (not covered yet)

Power Management

Sleep is supported since Linux 4.19.

WiFi

  • (not covered yet)


System Summary

lsusb

lsusb -v | grep -E '\<(Bus|iProduct|bDeviceClass|bDeviceProtocol)' 2>/dev/null

Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
  bDeviceClass            9 Hub
  bDeviceProtocol         0 Full speed (or root) hub
  iProduct                2 Generic Platform OHCI controller
Bus 001 Device 005: ID 15ba:003c Olimex Ltd. 
  bDeviceClass            0 (Defined at Interface level)
  bDeviceProtocol         0 
  iProduct                2 TERES Keyboard+Touchpad
  (Bus Powered)
Bus 001 Device 003: ID 1908:2311 GEMBIRD 
  bDeviceClass          239 Miscellaneous Device
  bDeviceProtocol         1 Interface Association
  iProduct                2 USB2.0 PC CAMERA
      (Bus Powered)
  bDeviceClass          239 Miscellaneous Device
  bDeviceProtocol         1 Interface Association
  (Bus Powered)
Bus 001 Device 002: ID 05e3:0608 Genesys Logic, Inc. Hub
  bDeviceClass            9 Hub
  bDeviceProtocol         1 Single TT
  iProduct                1 USB2.0 Hub
  bDeviceClass            9 Hub
  bDeviceProtocol         0 Full speed (or root) hub
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
  bDeviceClass            9 Hub
  bDeviceProtocol         0 Full speed (or root) hub
  iProduct                2 EHCI Host Controller

USB Host controllers entries (without OHCI, UHCI, EHCI) are removed too.

Resources

Attachments

Some configuration files and sample outputs.

  • [get | view] (2018-04-07 09:22:19, 0.2 KB) [[attachment:boot.txt]]
 All files | Selected Files: delete move to page copy to page

Credits



CategoryLaptopComputer