PINE64 - User contributions [en]

PinePhone Software Releases

2022-10-12T04:59:11Z

Strit: /* Download */ Define defaults are only for phosh

This page contains a list of all available operating systems for the [[PinePhone]] in alphabetical order, as well as links to other resources.

{{Info|Some releases may not have a good setup for the backlight at low brightness. If configured too low, the backlight shuts down completely, but the screen is still displayed and usable in bright front-light.}}

See [[PinePhone Installation Instructions]] on how to install the operating systems. Please see [[PinePhone Updating Instructions]] for how to update the phone.

== Software Releases ==

=== Multi-distro demo image ===

{{Warning | This is a demo image for testing different OSes before installing a regular image. Attempting to use this image productively is highly discouraged. The kernel is shared across the different OSes and is not updated.}}

This image allow users to try many Linux distributions easily, without having to figure out how to flash them individually and juggle with many microSD cards. Also called megi's 15-in-1 multi boot image.

* Main page: https://xnux.eu/p-boot-demo/
* Git repo: https://megous.com/git/pinephone-multi-boot/
* Forum discussion: [https://forum.pine64.org/showthread.php?tid=11347 15-distro multi-boot image for Pinephone]

==== Download ====

'''Update 2022-01-26, using megi's kernel 5.16.2'''

DD image to SD card and boot. This image is for 16GiB or larger SD cards, also works if flashed to eMMC.

This is also a good build for charging depleted battery. Just boot up this build with power supply connected, keep the PinePhone charging for 3 hours at power down stage.

For more info on this build, please visit its entry the "News" section of its [https://xnux.eu/p-boot-demo/ web page].

* [https://dl.xnux.eu/p-boot-multi-2022-01-26.torrent Download torrent file from author's website]
* [http://dl.xnux.eu/p-boot-multi-2022-01-26/ Download img.zst from author's website] (speed limited to 512KiB/s)
* [http://mirror.uxes.cz/dl.xnux.eu/ Download torrent and img.zst from discord user uxes' mirror]
** '''File name:''' multi.img.zst
** '''SHA-256:''' 39915b9d2aa2f33fd78552ac9a0e665c4aef97dd68a9f9a6c76f9fa2f0ac049e
** '''File Size:''' 6.9GiB

Due to its size, download though torrent is suggested by the author on its main page.

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! General
| <code>1111</code>
|-
! sxmo
| <code>user/1111</code>
|-
! Manjaro
| seems to insist on <code>123456</code>
|}

==== Notes ====

{{Info | Note about zstd) archive file (<code>.zst</code>):

On Linux, you may install or compile <code>zstd</code>, then write the image to SD card by piping <code>zstdcat</code> and <code>dd</code>. See the "Installation" section of its [https://xnux.eu/p-boot-demo/ web page] for command examples.

On Windows, instead of the offical [https://github.com/facebook/zstd zstd] command line program, you may use [https://github.com/mcmilk/7-Zip-zstd 7-zip-zstd]. Different installation method is provided in their README. Install 7-Zip-zstd / zstd, extract the disk image file (<code>.img</code>) from the zstd archive, and flash with tools like [https://sourceforge.net/projects/win32diskimager/ Win32 Disk Imager].}}

Also see [[PinePhone Installation Instructions]].

----

=== Arch Linux ARM ===
[[File:Archlinux-logo.png|right|100px]]

(Unofficial) Arch Linux ARM with choice of Phosh UI, Plasma Mobile, sxmo or barebones.
Currently being maintained by the [https://danctnix.org/ DanctNIX] community (GitHub: [https://github.com/DanctNIX/danctnix danctnix], [https://github.com/dreemurrs-embedded dreemurrs-embedded]).

==== Download ====

Get both stable and test builds at [https://github.com/dreemurrs-embedded/Pine64-Arch/releases GitHub releases].

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>alarm/123456</code>
|-
! root (barebone only)
| <code>root/root</code>
|}

==== Notes ====

* There are archmobile chat rooms on Matrix ([https://matrix.to/#/#archmobile:kde.org #archmobile:kde.org]) and Telegram ([https://t.me/archmobile @archmobile]).
* Feel free to send us [https://github.com/dreemurrs-embedded/Pine64-Arch/pulls pull requests] and reports [https://github.com/dreemurrs-embedded/Pine64-Arch/issues issues] on [https://github.com/dreemurrs-embedded/Pine64-Arch GitHub].
----

=== ExpidusOS ===

A fork of [https://voidlinux.org Void Linux] with a custom fork of XFCE called [https://github.com/ExpidusOS/genesis Gensis] as the default desktop environment, developed by [https://midstall.com/ Midstall Software].

* [https://expidusos.com ExpidusOS official website]
* [https://wiki.expidusos.com/index.php/Main_Page ExpidusOS Wiki]
* [https://discord.gg/GVfBF2w Midstall Software Discord server]
* GitHub: [https://github.com/ExpidusOS ExpidusOS]

==== Download ====

Check the [https://expidusos.com/download download page] for that latest version, or the [https://build.expidusos.com/ image file list] for all versions, look for the filename that starts with "pinephone".

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>expidus/expidus</code>
|}

==== Notes ====

What works, what does not work:

* The ExpidusOS Wiki has a page detailing [https://wiki.expidusos.com/index.php/Device:PinePhone supported features].

How to contribute and report defects:

* Join the [https://discord.gg/GVfBF2w Discord server] or corresponding repo at GitHub ([https://github.com/orgs/ExpidusOS/repositories repo list]).

----

=== Fedora ===
[[File:Fedora-logo.png|right|100px]]

An (unofficial) vanilla Fedora rawhide build for aarch64 with megi's kernel and [https://copr.fedorainfracloud.org/coprs/njha/mobile/packages/ some additional packages] to tie it all together.
It aims to eventually be an upstream part of the Fedora project, rather than a phone-specific distribution.

* Forum discussion: [https://forum.pine64.org/showthread.php?tid=9347 Fedora + Phosh for PinePhone]
* GitHub: [https://github.com/nikhiljha/pp-fedora-sdsetup nikhiljha/pp-fedora-sdsetup]

==== Download ====

* [https://github.com/nikhiljha/pp-fedora-sdsetup/releases Flashable images]
* [https://github.com/nikhiljha/pp-fedora-sdsetup Build scripts]
* [https://copr.fedorainfracloud.org/coprs/njha/mobile/ Packages (Fedora COPR)]

There is also an FTP server with images build every night @ ftp://pine.warpspeed.dk/nightly/pinephone/ (Mount this with something like Nautilus)

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! GitHub images
| <code>pine/123456</code>
|-
! Nightly images (via FTP)
| <code>pine/1111</code>
|}

==== Notes ====

WiFi, Bluetooth, SMS, Data, Calls all work! There are still a few bugs though, and [https://xnux.eu/devices/pine64-pinephone.html#toc-feature-driver-support-matrix some features don't have driver support yet] on any PinePhone distribution.

Please send your bug reports to [https://github.com/nikhiljha/pp-fedora-sdsetup/issues the project's issue tracker]. Be sure to include logs if applicable! Send us pull requests on [https://github.com/nikhiljha/pp-fedora-sdsetup/pulls Github].

----

=== Gentoo ===
[[File:GentooLogo.png|right|100px]]

There are unofficial Gentoo overlays with ebuilds for the PinePhone. There are no images - the image must be built manually, including picking the kernel, bootloader and the desired desktop environment. The ARM64 version of Gentoo has to be selected.

==== Download ====

Overlay locations:

* https://gitlab.com/bingch/gentoo-overlay
* https://github.com/stealthgun/gjdwebserver-overlay

==== Notes ====

The documentation can be found here:

* https://stealthgun.tweakblogs.net/blog/19336/gentoo-on-a-pinephone
* https://wiki.gentoo.org/wiki/User:Dr41nU/PinePhone
* https://wiki.gentoo.org/wiki/PinePhone (incomplete)

{{Info|Please consider cross-compiling the software on the computer. Long compilation times and heat production can lead to a reduced lifespan of the phone.}}

----

=== GloDroid ===

A fully open source port of Android to the PinePhone.

GitHub: [https://github.com/GloDroid/ GloDroid]

==== Download ====

* Stable image: [https://github.com/GloDroid/glodroid_manifest/releases GloDroid]

==== Notes ====

Feature overview:

* Works: WiFi, screen dimming, sound, touchscreen, charging and telephony(partially) works.
* Doesn't work: Bluetooth and GPS

----

=== Kali Linux ===
[[File:Kali-logo.png|right|200px]]

An unofficial [https://www.kali.org Kali Linux] build for PinePhone running with Phosh.
This Kali Linux Phosh build contains only the Phosh GUI and a few other packages (ModemManager, WiFi chip firmware).
Now, Totally depends on The Kali repository. Get [https://github.com/Shubhamvis98/usb-arsenal-pinephone USB Arsenal] for your PinePhone's Kali Linux. Packet Injection is working now, use iwconfig instead of airmon-ng.

==== Download ====

* [https://github.com/Shubhamvis98/kali-pinephone/releases Kali Phosh]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>kali/8888</code>
|}

==== Notes ====

Installation:

$ unxz -c Kali-PinePhone-{Release}.img.xz | dd of=/dev/{storage_block} bs=1M status=progress
$ growpart /dev/mmcblkX Y
$ e2fsck -y -f /dev/mmcblkXpY
$ resize2fs /dev/mmcblkXpY
# X: Storage Device Y: Partition Number

----

=== LuneOS ===
[[File:Luneos-logo-256.png|right|100px]]

LuneOS is one of the original multi-tasking OS-es that runs on Linux. Based on HP/Palm's webOS, merged with latest technology stack from LG called webOS OSE (a derivative of what LG uses on their Smart TV's), software such as Qt5 and makes use of the Yocto build system.

* [https://www.webos-ports.org/wiki/Main_Page WebOS Ports Wiki]
* [https://webos-ports.org/wiki/Pinephone_Info WebOS-Ports Wiki's Pinephone page]
* GitHub: [https://github.com/webOS-ports WebOS Ports]

==== Download ====

* LuneOS Preview images: [https://github.com/webOS-ports/meta-pine64-luneos/releases Downloads]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>root</code>
|}

==== Notes ====

In order to connect to the device using SSH/SCP via WiFi: You can simply connect via SSH/SCP via WiFi using the PinePhone's IP address on port 22.
----

=== Maemo Leste ===
[[File:Maemoleste-logo.png|right|100px]]

[https://en.wikipedia.org/wiki/Maemo Maemo] is a trimmed-down version of Debian for mobile devices,
originally a collaboration between Nokia and many open source projects (the [http://maemo.org/intro/ Maemo community]) before Nokia abandoned it. The more well-known devices Maemo supports are the OpenMoko and N900. The community now takes full responsibility in developing fully open source Maemo for a variety of mobile devices. You may be interested to learn more about the features in their [https://leste.maemo.org/Leste_FAQ Maemo Leste FAQ].

Maemo 8 "Leste" is an ARM64 port of [https://devuan.org/ Devuan] (Debian without systemd) and runs the mainline Linux kernel.
The default user interface stack is [https://en.wikipedia.org/wiki/Hildon Hildon], [https://en.wikipedia.org/wiki/X.Org_Server Xorg], [https://en.wikipedia.org/wiki/Matchbox_(window_manager) Matchbox WM], and [https://en.wikipedia.org/wiki/GTK GTK].

==== Download ====

* [http://maedevu.maemo.org/images/pinephone/ Maemo Leste test builds]

There is also an [https://github.com/maemo-leste/image-builder image builder], see the wiki for instructions on how to [https://leste.maemo.org/Image_Builder build a custom image]. For current status and instructions, please read their [https://leste.maemo.org/PinePhone PinePhone wiki page].

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! root
| <code>toor</code>
|-
! user
| <code>12345 (lockscreen)</code>
|}

==== Notes ====

Most discussion occurs at [ircs://irc.libera.chat:6697/#maemo-leste <code>#maemo-leste</code> on <code>irc.libera.chat</code>] and [https://talk.maemo.org/showthread.php?t=100192&page=60 this thread].

All other contact information is listed on the [https://leste.maemo.org/Main_Page main page] of the Maemo wiki.

Submit [https://github.com/maemo-leste/bugtracker/issues bug reports] on github.
To track known issues, you may use these search terms:
[https://github.com/maemo-leste/bugtracker/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+pinephone pinephone],
[https://github.com/maemo-leste/bugtracker/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+pine64 pine64].

----

=== Manjaro ARM ===
[[File:Manjaro-logo.svg|right|100px]]

Manjaro is a user-friendly Linux distribution based on the independently developed Arch operating system with the Plasma Mobile and Phosh desktop environment.

==== Download ====

* Phosh: [https://github.com/manjaro-pinephone/phosh-dev/releases Dev] and [https://github.com/manjaro-pinephone/phosh/releases Stable]
* Plasma Mobile: [https://github.com/manjaro-pinephone/plasma-mobile-dev/releases Dev] and [https://github.com/manjaro-pinephone/plasma-mobile/releases Stable]
* Lomiri: [https://github.com/manjaro-pinephone/lomiri-dev Dev] (unmaintained)

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials (Only Phosh)
|-
! Default user
| <code>manjaro/123456</code>
|-
! root
| <code>root/root</code>
|}

==== Notes ====

The installation of the stable images is strongly suggested. The dev images might break frequently.

----

=== Mobian ===
[[File:Debian-logo.png|right|100px]]

An unofficial [https://www.debian.org Debian] build for ARM64 running with Phosh (developed by Purism, uses Wayland instead of Xorg).
The base system is pure Debian, with only the GUI applications and a few others (ModemManager, WiFi chip firmware) being built from modified sources (as well as the kernel and u-boot).
Current version is Debian Bookworm.

==== Download ====

* [https://images.mobian.org/pinephone/ Images]

{{Info|Tow-Boot is required to be able to boot the images, see [https://wiki.mobian-project.org/doku.php?id=install-linux here]!}}

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>mobian/1234</code>
|}

==== Notes ====
The development is work in progress. See [https://gitlab.com/mobian1/devices/pinephone-support pinephone-support] for further information. The Mobian wiki can be found [https://wiki.mobian-project.org/ here].

In order to connect to the device using SSH/SCP via WiFi, you need to install SSH on the device. You can do this by executing the following in a shell: "sudo apt-get install ssh", afterwards you can connect via SSH/SCP via WiFi using the PinePhone's IP address on port 22.

----

=== Nemo Mobile ===
[[File:nemo_mobile.png|right|100px]]

Nemo Mobile is the open source build of Sailfish OS with a open source UI called [http://nemomobile.net/glacier-home/ Glacier], [http://nemomobile.net/pages/Hello_manjaro/ based on Manjaro].

==== Download ====

[https://img.nemomobile.net/2022.05/Manjaro-ARM-nemomobile-pinephone-0.9.img.xz Image]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>manjaro/123456</code>
|-
! root
| <code>root/root</code>
|}

==== Notes ====
The website of the Nemo Mobile UX Team can be found [https://nemomobile.net/ here]. Please report bugs regarding the Nemo Mobile UI as [https://github.com/nemomobile-ux/main/issues GitHub issue].

----

=== NixOS ===
[[File:nixos.png|right|100px]]

NixOS is a Linux distribution built on top of the Nix package manager using declarative configuration to allow reliable system upgrades.

==== Download ====
There is no pre-built complete image.
For now users, are expected to follow the instructions in the [https://mobile.nixos.org/getting-started.html Getting Started page],
and [https://mobile.nixos.org/devices/pine64-pinephone.html Project's device page].

==== Notes ====
Project home page: [https://mobile.nixos.org/ Mobile NixOS]
----

=== OpenMandriva Lx ===
[[File:Oma-logo-22042013_300pp.png|right|100px]]

OpenMandriva Lx with Plasma Mobile as UI.

==== Download ====

The official image can be found [https://sourceforge.net/projects/openmandriva/files/release/4.2/RC/Pinephone/ at sourceforge.net].
See [https://www.openmandriva.org/en/news/article/openmandriva-lx-4-3-rc-available-for-testing here] for the offical announcement.

==== Notes ====

{{Info| This image is solely for testing purposes.}}

----

=== openSUSE ===
[[File:SLEM-OS-logo.png|right|100px]]

Our images use the same [https://en.opensuse.org/Portal:Tumbleweed openSUSE Tumbleweed] base as our desktop images,
except what needs to be changed for the PinePhone.
The images include zypper (RPM) as the default package manager,
and have access to virtually the same (open source) software as our desktop repositories,
thanks to the [https://en.opensuse.org/Portal:Factory Factory] ports.
Using [https://en.opensuse.org/SDB:DNF dnf] is possible, if preferred.

==== Download ====

* [https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PHOSH-pinephone.aarch64.raw.xz Phosh] / [https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PHOSH-pinephone.aarch64.raw.xz.sha256 SHA-256] / [https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PHOSH-pinephone.aarch64.raw.xz.sha256.asc SHA-256 Signature]
* [https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PLAMO-pinephone.aarch64.raw.xz Plasma Mobile] / [https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PLAMO-pinephone.aarch64.raw.xz.sha256 SHA-256] / [https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PLAMO-pinephone.aarch64.raw.xz.sha256.asc SHA-256 Signature]

To verify the images you need to import [https://build.opensuse.org/projects/devel:ARM:Factory:Contrib:PinePhone/public_key our GPG key].
Keep on mind that the first boot may stay on black screen for about a minute - consequent boots should be faster.

You can find install instructions at [https://en.opensuse.org/HCL:PinePhone#Installing_openSUSE_in_a_Pinephone this section] in the openSUSE Wiki.

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| <code>pine/1234</code>
|-
! root
| <code>root/linux</code>
|}

==== Notes ====

You can find all information about the releases of the project [https://gitlab.com/slem.os/slem.os/-/blob/master/CHANGELOG.md here].
Detailed information, tips and troubleshooting suggestions are also provided at [https://en.opensuse.org/HCL:PinePhone the openSUSE Wiki].
You will also find information in our wiki on how to report issues (Contributing section).
----

=== postmarketOS ===
[[File:PostmarketOS-logo.png|right|100px]]

postmarketOS extends [https://www.alpinelinux.org/ Alpine Linux] to run on smartphones and other mobile devices.
It offers various user interfaces (Phosh, Plasma Mobile, Sxmo, Plasma Desktop, Gnome 3, Kodi, XFCE4, ...).

==== Download ====
[https://postmarketos.org/download/ Download page]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Test images user
| <code>user/147147</code>
|}

==== Notes ====
As of writing, official images are provided with Phosh, Plasma Mobile and Sxmo.
The official images come in two flavors, either as a test image to try out postmarketOS, or with the installer.

When using the installer images (recommended), it is possible to:
* encrypt the installation
* install from the SD card to eMMC

Power users may also create their own image with the distribution's install and development tool <code>pmbootstrap</code>.

See the [https://wiki.postmarketos.org/wiki/PINE64_PinePhone_(pine64-pinephone) pine64-pinephone] page of the postmarketOS wiki for details.
----

=== Sailfish OS ===
[[File:Sailfish_logo.png|right|100px]]

[https://sailfishos.org/ Sailfish OS] is a Linux-based operating system based on open source projects such as [https://wiki.merproject.org/wiki/Main_Page Mer], and a closed source UI based on [https://sailfishos.org/wiki/Lipstick Lipstick].

* [https://wiki.merproject.org/wiki/Adaptations/PinePhone64 PinePhone Wiki Page] on Mer Wiki, for both Nemo Mobile and Sailfish OS.
* [https://gitlab.com/pinephone-sailfish-os/linux-kernel/ Linux kernel config repo]
* [https://gitlab.com/sailfishos-porters-ci/dont_be_evil-ci/ Sailfish OS repo]

==== Download ====

'''Flashing script'''

The Sailfish OS image is built on Gitlab CI. The latest image can be installed using the [https://raw.githubusercontent.com/sailfish-on-dontbeevil/flash-it/master/flash-it.sh flashing script].

The script downloads the image and bootloader from the CI, extracts everything and burns it onto the SD card.
Note: The script will format and erase the SD card!

Instructions:
# Download the flashing script
# Insert a microSD card in your device
# Make the script executable: <code>chmod +x flash-it.sh</code>
# Verify that you have the <code>bsdtar</code> package installed
# Execute it: <code>./flash-it.sh</code>
# Follow the instructions. Some commands in the script require root permissions (for example: mounting and flashing the SD card).

* When asked where to flash, type 'raw' and it will build the image on your computer. Otherwise define the path /dev/.... to flash to card or internal emmc.

'''username/password'''

Set PIN on initialization.

==== Notes ====

* Sometimes the first run stalls before the tutorial. Reboot and it will start from setting the security pin.
* The homescreen may be locked unless you boot with a sim card inserted. An old expired sim will do. '''If you do not have a SIM card on hands, do NOT set a security code on first boot.'''
* When a screen with a loading circle is displayed, just left/right swipe it away.
* If you're not familiar with Sailfish OS, pay attention to the tutorial - the interface works great, but is not immediately obvious. If you are familiar with it, you can skip the tutorial by touching all 4 corners starting top left.

'''What works, what does not work'''

See the [https://wiki.merproject.org/wiki/Adaptations/PinePhone64#Hardware_Support Hardware Support section] on the Mer Wiki's PinePhone Page.

There is a limited selection of apps available from the Jolla store, the vast majority are hosted on openrepos.net. If the Storeman app for openrepos is not preinstalled, download the RPM and click to install.

'''How to contribute and report defects'''

See the [https://wiki.merproject.org/wiki/Adaptations/PinePhone64#Installation Installation section] on the Mer Wiki's PinePhone Page for compile, build and development.

Git repo links are at the top of this OS section. other repos that may be helpful:

* [https://github.com/sailfish-on-dontbeevil GitHub project page]
* [https://github.com/sailfish-on-dontbeevil/flash-it the repo of the flash-it.sh flashing script]
* [https://build.merproject.org/project/show/nemo:devel:hw:pine:dontbeevil Mer Open Build Service page] ([https://forum.sailfishos.org/t/changes-needed-to-merge-the-project-names-to-sailfish-os/1672 Mer is being assimilated into Sailfish OS] and [https://forum.sailfishos.org/t/obs-shut-down-and-next-steps/1814 OBS is shutting down], also see [https://specs.openstack.org/openstack/fuel-specs/specs/7.0/replace-obs.html OpenStack is replacing OBS with another build system based on Jenkins], if it's related, even OBS come back under Sailfish OS, it will be different.)

See the [https://sailfishos.org/wiki/Collaborative_Development#Reporting_issues Sailfish OS wiki] for links to their forum, as well as info required when reporting an issue. See the [https://sailfishos.org/wiki/SailfishOS Sailfish OS wiki main page] for options to contribute to Sailfish OS.

'''Notes'''

OTA is supported: <code>zypper refresh && zypper update</code> as root (<code>devel-su</code> to get root access). Things that need reflash are bootloader specific at the moment. If improvements like [[Crust]] or changes of partition layout are added, then you need to reflash.
----

=== SkiffOS ===
[[File:SkiffOS-Icon-1.png|right|100px]]

Minimal in-memory cross-compiled OS optimized for hosting multiple in parallel Docker containers. Provides the reliability of firmware with the ease-of-use of package managers.

==== Download ====

The repository and instructions can be found [https://github.com/skiffos/SkiffOS/tree/master/configs/pine64/phone here].

==== Notes ====

Upgrade over-the-air via a simple rsync script, or copying 3 files.

Uses the [http://buildroot.org Buildroot] cross-compilation tool for support for all Pine64 boards.

Use configuration packages to configure distro:

{| class="wikitable"
! Package !! Distro
|-
| core/pinephone_neon || KDE Neon via Ubuntu repositories
|-
| core/pinephone_nixos || Nixos Mobile
|-
| core/pinephone_gentoo || Gentoo with Link-time Optimization & KDE Mobile or Phosh
|-
| core/pinephone_ubports || Ubuntu Ports for PinePhone
|-
| core/pinephone_manjaro_kde || Manjaro for PinePhone: KDE variant
|-
| core/pinephone_manjaro_phosh || Manjaro for PinePhone: Phosh variant
|-
| core/pinephone_manjaro_lomiri || Manjaro for PinePhone: Lomiri variant
|}

The boot-up OS is upgraded independently from the containers.

----

=== Slackware ===

[https://arm.slackware.com/ Slackware] is the world's oldest actively developed Linux distribution, providing a modern user land (applications) and Linux Kernel, within a more classic Unix Operating System environment.

==== Download ====

* http://dl.fail.pp.ua/slackware/images/pinephone/

==== Notes ====

Discussion: [https://forum.pine64.org/showthread.php?tid=12181&highlight=slackware+pinephone Thread]

----

=== Ubuntu Touch ===
[[File:Ubports-logo.png|right|100px]]

A Mobile Version of the Ubuntu Operating System made and maintained by the UBports Community.

Ubuntu touch is a mobile version of Ubuntu developed by the UBports community.
Installation instructions can be found on
[https://gitlab.com/ubports/community-ports/pinephone#how-do-i-install-ubuntu-touch-on-my-pinephone the UBports PinePhone project].
There is also a [https://github.com/goddard/pinephone/ script] to download the latest image and flash to your PinePhone.
In the future, Ubuntu Touch will be able to be installed onto the PinePhone with the [https://devices.ubuntu-touch.io/installer UBports installer] GUI tool.

==== Download ====

[https://gitlab.com/ubports/community-ports/pinephone#how-do-i-install-ubuntu-touch-on-my-pinephone UBports PinePhone project]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Default user
| Set during boot
|}

==== Notes ====

Scroll down to the bottom of [https://gitlab.com/ubports/community-ports/pinephone this page], or directly here [https://devices.ubuntu-touch.io/device/pinephone/#deviceOverview] to see which features work.

Contributions and bug reports can be made via. [https://gitlab.com/ubports/community-ports/pinephone UBports gitlab page]. See [https://ubports.com/foundation/sponsors UBports website] for how to donate.

== Tools ==

There are software tools, that can be booted on the PinePhone.

=== JumpDrive ===

JumpDrive can be used to flash the eMMC (and the microSD card), see [[PinePhone Installation Instructions#Using JumpDrive]].

See https://github.com/dreemurrs-embedded/Jumpdrive/releases for the latest image.
Make sure to download the "PinePhone" image and to unpack the archive before flashing.

----

=== Tow-Boot ===
Tow-Boot is a more user-friendly distribution of U-Boot. Can also mount internal storage as USB Mass Storage by holding the volume up button at startup before and during the second vibration and the LED will turn blue if done successfully.

See https://github.com/Tow-Boot/Tow-Boot/releases for the latest image.
Make sure to download the image with pinephoneA64 in the name.

== Factory Test OS ==

On the Braveheart model, there was a postmarketOS based basic Factory Test OS pre-installed on the eMMC.The developer Martijn Braam from postmarketOS has improved the functionality of the image considerably later. Since the 20200501 version, it is able to test all the hardware. It also includes functionality to install a new OS to the eMMC when using with an test image that includes that OS image. The downloadable image just does the hardware tests. Do not flash eMMC to test your device, just dd it to microSD and test from there. New versions are distributed as part of the postmarketOS distribution.

{{Info| The magnetometer test will fail on the new Beta Edition, as the factory image wasn't updated for it yet.}}

Links:
* [https://images.postmarketos.org/pinephone/ Software Images] (download the latest one named like pine-pinephone-yyyyMMdd-factorytestX.img.xz)
* [https://gitlab.com/MartijnBraam/factorytest Git repo]
* [https://gitlab.com/MartijnBraam/factorytest/-/blob/master/README.rst Documentation]

=== Factory-loaded OS builds ===

These are different operating system builds that was preloaded in the factory with testing utility.

Download the build, extract the image and dd it to a 8 GB or larger microSD card, then insert it into the PinePhone.
After power up or reboot, you may perform and complete the test routine, or apply the build from microSD card to eMMC.

All the download links below are direct download from pine64.org.

<div style="overflow: auto;">
{| class="wikitable" style="white-space: nowrap"
! OS
! Download Link
! File Size
! MD5
|-
| Beta Edition
| [https://files.pine64.org/os/PinePhone/BetaEdition/pine64-pinephone-plamo-beta-factorytest.img.xz pine64-pinephone-plamo-beta-factorytest.img.xz]
| 1.78GB
| <code>f16bce93504a52217540ac886863a418</code>
|-
| Mobian
| [https://files.pine64.org/os/PinePhone/Mobian/pine64-pinephone-20201207-factorytest-mobian.img.xz pine64-pinephone-20201207-factorytest-mobian.img.xz]
| 1.41GB
| <code>015be381ff4e650a7fca6d4eaa90d63d</code>
|-
| KDE
| [https://files.pine64.org/os/PinePhone/KDE/pine64-pinephone-20201208-factorytest-kde.img.xz pine64-pinephone-20201208-factorytest-kde.img.xz]
| 2.28GB
| <code>32979ff17b5ec4d358ce99f1aff0c77c</code>
|-
| Manjaro
| [https://files.pine64.org/os/PinePhone/Manjaro/pine64-pinephone-20201013-manjaro-stable-20201018-factory56.img.xz pine64-pinephone-20201013-manjaro-stable-20201018-factory56.img.xz]
| 1.04GB
| <code>4edfd4dceaefdd32a3417c1727161c29</code>
|-
| postmarketOS
| [https://files.pine64.org/os/PinePhone/PostMarketOS/pine64-pinephone-20200726-phosh-v20.05-factory.img.xz pine64-pinephone-20200726-phosh-v20.05-factory.img.xz]
| 517MB
| <code>244093be2f6d728fcbd1d29114607727</code>
|-
| Ubuntu Touch
| [https://files.pine64.org/os/PinePhone/UBPorts/PinePhone-flasher-ubuntu-7b.img.gz PinePhone-flasher-ubuntu-7b.img.gz]
| 1.05GB
| <code>2d7f5271e7a281db8f1b1219bedbe131</code>
|}
</div>

== Installing other ARM64 distributions ==

{{Warning|Distributions not on this page may not even boot after you follow this section. In the best case, they will be barely usable.
This is more for fun, or if you would like to port a new distribution to the PinePhone.}}

{{Hint|'''Note:''' This section uses megi's kernel releases, and not the official ones from Pine64. While it is possible to use the official (and in the future, mainline) kernel, megi provides binary releases, which makes it very easy.}}

General steps:

# Create a boot partition (from 4 MB to about 252 MB) and a root partition (from the end of boot to the end of the card) filesystem on the SD card.
# Format the boot partition with vfat, and the root partition with a supported filesystem like ext4 or f2fs.
# Extract the root filesystem from your distribution's ARM image into the root filesystem on the SD card. Do not copy the partition, copy the files instead (in archive mode, like <code>rsync -ar</code>).
# Edit <code>/etc/fstab</code> to match your partitions.
# Grab megi's kernel from https://xff.cz/kernels/, Follow the instructions in the [https://xff.cz/kernels/README README], which involves copying the kernel modules into the SD card rootfs, and writing u-boot and the bootloader.

If you would like to see examples or specific commands for how to complete these steps, see:
* [https://github.com/nikhiljha/pp-fedora-sdsetup an example for Fedora], current unofficial [#Fedora] release
* [https://xnux.eu/howtos/install-arch-linux-arm.html an example for Arch Linux] by megi

== Other Resources ==

Community
* [[Main_Page#Community_and_Support|Links to the community services]]

Hardware information
* [[PinePhone|General PinePhone hardware info]] in this Pine64 wiki
* Details specific to the Braveheart Edition: [[PinePhone_v1.1_-_Braveheart|PinePhone 1.1 Braveheart hardware details]]
* Details specific to the Community Edition: [[PinePhone_v1.2|PinePhone 1.2 hardware details]]
* The postmarketOS wiki has a detailed page on the PinePhone hardware [https://wiki.postmarketos.org/wiki/PINE64_PinePhone_(pine64-pinephone) here] and the preceding devkit [https://wiki.postmarketos.org/wiki/PINE64_Don%27t_be_evil_devkit_(pine64-dontbeevil) here]

Other software information
* [https://linux-sunxi.org/Main_Page sunxi community wiki]
* [https://xnux.eu/devices/pine64-pinephone.html megi's feature/driver support matrix]
* [https://megous.com/dl/tmp/README.bootui megi bootUI notes (for dualbooting/multibooting)] see demonstration [https://www.youtube.com/watch?v=ZL1GREqoqx8 on YouTube]
* [https://github.com/ayufan-pine64/boot-tools ayufan boot tools]

Other
* [https://pine64.com/?post_type=product Pine64 shop]
* [https://www.pine64.org/2020/01/24/setting-the-record-straight-pinephone-misconceptions/ Pine64 blog on blobs]
* [https://tuxphones.com/yet-another-librem-5-and-pinephone-linux-smartphone-comparison/ Martijn Braam Librem 5 comparison, especially covering openness/blobs]
* [https://fam-ribbers.com/2019/12/28/State-of-Linux-on-mobile-and-common-misconceptions.html Bart Ribbers blog on Linux distributions and desktop environments on mobile devices]
* [https://www.jeffgeerling.com/blog/2019/a2-class-microsd-cards-offer-no-better-performance-raspberry-pi Jeff Geerling on testing microSD cards]

[[Category:PinePhone]]

Quartz64 Development

2022-10-11T15:04:11Z

Strit: /* Upstreaming Status */ update Battery status

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="3" | Video Output
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchipdrm/VOP2</code>
|
As of 5.19-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=604be85547ce4d61b89292d2f9a78c721b778c16], Also featured in Phoronix Article[https://www.phoronix.com/scan.php?page=news_item&px=Rockchip-VOP2-Linux-5.19]
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/commit/d7ad116fb30d11d110aeb880754cf27f34c45c40#7e8e2ef87e479c54539dc519c0b92d6b31727f8d_671_681] Coordinate any porting with Rockchip first
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=678297&archive=both]
| <code>dw-mipi-dsi-rockchip</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/gpu/drm/rockchip/dw-mipi-dsi.c]
|
|-
! scope="row" | 3D Acceleration
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=810028668c6d9da25664195d6b906c98a8169f72]
|-
! scope="row" rowspan="3" | Video Decode
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:LightYellow; text-align:center;" rowspan="3"|GStreamer only, no ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro</code> using <code>v4l2-requests</code>
| VDPU121 handling 1080p H.263, MPEG-1, MPEG-2, VP8 and H.264. Mainline as of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=5f6bfab6da6531238e899fdf29efd6d0185adc3e]
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkvdec2</code> using <code>v4l2-requests</code>
| VDPU346 handling 4K H.265, H.264 and VP9
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkdjpeg</code> using <code>v4l2-requests</code>
| VDPU720 handling JPEG, [[User:CounterPillow]] is working on this
|-
! scope="row" rowspan="5" | [[Mainline Hardware Encoding|Video Encode]]
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=649611]
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| VP8 on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU540
| rkvenc-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.265 on VEPU540
| rkvenc-based
|
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model B
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c37415f55bdadffe5b4c0e7981e9fc7e8b96beea]
| Quartz64 Model B
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| SOQuartz
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c466828fb3ba8cb7f5c3bf28766da9b70bf9745e]
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-charger</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/power/supply/rk817_charger.c?id=11cb8da0189b417392e2334ae967b0ba1f0d1be8]
| Quartz64 Model A, Pinenote
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:LightYellow; text-align:center;"|In review (RFC)[https://lore.kernel.org/linux-rockchip/20220413221916.50995-1-samuel@sholland.org/T/]
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk35/ebc-drm-v5 here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>naneng-combphy</code>
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7160820d742a16313f7802e33c2956c19548e488]. Still requires DTS changes
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" rowspan="2" | CSI Camera
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rkisp</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/isp]
|
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|linux-next[https://patchwork.kernel.org/project/linux-rockchip/list/?series=661385]
| <code>rockchip-inno-csidphy</code>
|
|
|-
! scope="row" | NPU
| colspan="2" style="background:#F99; text-align:center;"|Needs writing
|
| Downstream version is a closed source SDK. Major undertaking to reimplement this as Linux does not (yet) appear to have a generic architecture for neural accelerators.
|
|-
! scope="row" | Crypto
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rk-crypto</code> v2
| Downstream driver [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/crypto/rockchip] doesn't include a rk3568 compatible either, but the TRM shows that it seemingly matches.
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper
* Microphone Input
* CSI — needs CIF driver
* eDP — needs PHY driver and controller driver
* DSI

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

=== eDP Driver Porting ===

The eDP PHY driver and controller driver needs to be ported, brought into shape and submitted with proper commit attribution to the Rockchip authors.

[[User:CounterPillow]] has experimentally ported stuff, but it's currently not working.

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box if the generic PHY driver is y and binds first. Alternatively tell users in board-specific setup instructions to force including the <code>motorcomm</code> module in initramfs if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_MMC_SDHCI_OF_DWCMSHC</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_PHY_ROCKCHIP_INNO_DSIDPHY</code>
** MIPI DSI DPHY (note: requires in-review patches linked in status table)
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_CHARGER_RK817</code>
** RK817 charger (note: requires in-review patches linked in status table)
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support
* <code>CONFIG_PHY_ROCKCHIP_INNO_CSIDPHY</code>
** MIPI CSI DPHY

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Pinebook Pro Troubleshooting Guide

2022-06-27T20:40:33Z

Strit: /* Manjaro Updates Fail With 404 */ update URL

=Useful Links=

[[Pinebook_Pro|Back to the main Pinebook Pro page]]

[[Pinebook_Pro_Hardware_Accessory_Compatibility|Hardware Compatibility page]]

[[Pinebook Pro Software Release]]

=Tips, tricks and other information for troubleshooting your Pinebook Pro=

If something has gone wrong, the key thing is remain calm and not do anything hasty and make things worse, particularly when flashing the eMMC or firmware. Try and make a record of all the things you did in the run-up to the problem (even to the point of using a camera to take a note of errors on the screen, this record can be vital later).

=Manjaro Updates Fail With 404=
If you have an old Manjaro installation then it will have the wrong repositories/mirrors set up and they won't work. Set up new repositories by following these instructions:
https://archived.forum.manjaro.org/t/another-mirror-transition-manual-intervention-required/132302

=Power And Boot=

== New from the factory - Pinebook Pro won't boot / power on ==
* Some Pinebook Pros came from the factory with the eMMC switch in the disabled position. It should be switched towards the back / hinge to enable the eMMC.
* The eMMC may have come loose during shipment. [[Pinebook Pro#Accessing the Internals - Disassembly and Reassembly|Open the back]] and verify that the eMMC is firmly seated.
* You may want to try unplugging the SD card daughterboard ribbon cable and see if it powers on (remove the battery and peel off a bit of the tape before unplugging it to avoid damage). If it does, try reseating it on both sides. It might have come loose during shipping.
* It's possible that your eMMC is empty from the factory. Simply [[NOOB|create]] a bootable [[Pinebook_Pro#Pinebook_Pro_images|SD card]] and see if your Pinebook Pro [[Pinebook_Pro#Boot_sequence_details|boots]]. If so, you can then [[NOOB|write]] an OS image to the eMMC.

== Pinebook Pro will not power on after toggling the eMMC enable/disable switch ==
* This may happen if you meant to toggle the UART/Headphone switch (9) towards touchpad for headphone use and instead you toggled the eMMC enable/disable switch (24).
* After reenabling eMMC by toggling switch (24) towards hinge, if Pinebook Pro does not turn on then press the RESET button (28). It is clearly marked 'reset' on the PCB board.

== Pinebook Pro will not power on after removing and replacing EMI shielding ==
* Closely inspect that the shielding is firmly seated in the clips on all sides. You can be seated in the clips on one axis, and have missed on an another axis.

== Pinebook Pro won't boot when using UART console cable ==
* If you're using the [[Pinebook_Pro#Using_the_UART|UART]] cable sold on the [https://pine64.com/product-category/pinebook-pro/ Pine Store], you may want to see if it boots after you disconnect it. Some users report that custom-made cables based on FTDI UART adapters do not cause this issue.
* Make sure your USB to serial UART device is 3.3v. Many are 5v and some even +-12v. Pinebook Pro's only support 3.3v and may act eratically when using higher voltage. Further, higher voltage could permananetly damage the Pinebook Pro's SoC.

== Pinebook Pro will not sleep with lid closed ==
A problem with the positioning of the lid magnet has been identified by several forum users in mid-2020 models of the Pinebook Pro. The magnetic field from the lid magnet operates a hall effect sensor located on the daughterboard (smallboard), which causes the Pinebook Pro to sleep when the lid is closed. If the magnet is not positioned correctly, the Pinebook Pro will not sleep when the lid is fully closed, but may sleep if the lid is open about an inch. If you experience this problem, repositioning of the magnet may be necessary.
=== Lid Magnet Repositioning Step-by-Step ===
*Read these steps thoroughly before starting. This is a somewhat laborious process involving fragile parts!
# Remove bottom cover.
# Disconnect LCD and webcam ribbon cable from main board. Flip the small black strip on the connector upward and the ribbon cable can be easily removed. Do not pull the cable out without first raising the black retaining mechanism.
# Remove the small black plastic standoffs on each hinge and set aside.
# Remove the three screws from each hinge on the display assembly.
# Move the hinges upward to a 90 degree angle independently from the main body. Then lift the main body to the same 90 degree angle and you should be able to separate the display assembly from the main body. Set the main body aside.
# Remove the plastic hinge cover on the display assembly. There's not really an easy way to do this, just work slowly and deliberately so as not to damage the sensitive cable inside. Start from either end and work your way inward. Use a small flathead screwdriver or similar tool to get started.
# Remove the hinges from the display assembly.
# Remove the rubber bumpers at the top corners of the display assembly to expose two screws. Remove the screws.
# Starting at the corners, separate the bezel from the lid. The clips that hold it in place are similar to those found on the hinge cover. Again, slow deliberate work will get it done. Work from the top down. Take care not to damage the cables in the bottom.
# With the bezel separated from the lid, feed the cable through the slot and set the bezel aside.
# Without removing the LCD panel completely, lift and move the panel slightly to the left, taking care not to damage the cable running underneath up to the webcam. This will give you room to remove the magnet without risking damage to the panel.
# The magnet is a silver colored bar near the bottom right side of the lid. Pry the magnet out with a small flathead or similar tool and set it aside. There is some adhesive but it's not very strong.
# Put the LCD panel back where it belongs. Note the foam pads on either side of the panel. The magnet is the same width as the foam pad that keeps the panel in place, and should fit perfectly in the same channel.
# The magnet should be placed about 1 to 1.5cm lower than where it was originally. There should be no need for adhesive, as the magnet will stick to the LCD panel. For reference, the hall effect sensor that the magnet interacts with is in between the USB port and audio jack.
# Reassemble using these steps in reverse order.

Your PineBook Pro should now sleep properly when the lid is closed.

=WiFi And Bluetooth=

== WiFi issues ==
* First, check the privacy switches to make sure your WiFi is enabled. They are persistant. See [[Pinebook_Pro#Privacy_Switches|Privacy Switches]]
* Next, you may have to modify the <code>/etc/NetworkManager/NetworkManager.conf</code> as root user, and replace <code>managed=false</code> with <code>managed=true</code>. Then reboot.
* For connections that drop and resume too often, it might be due to WiFi power management from earlier OS releases. Later OS releases either removed WiFi power management, or default to full power. (Power management can be turned off via command line with <code>iw dev wlan0 set power_save off</code> or <code>iwconfig wlan0 power off</code>, although it is not persistent through re-boot.)
* For connections that drop under load on the default Debian, remove <code>iwconfig wlan0 power off</code> in the file <code>/etc/rc.local</code>.
* If WiFi is un-usable or often crashes when using an alternate OS, then it might because its WiFi firmware is not appropriate for the WiFi chip in the Pinebook Pro. Try the latest firmware patch from [https://gitlab.manjaro.org/tsys/pinebook-firmware/tree/master/brcm https://gitlab.manjaro.org/tsys/pinebook-firmware/tree/master/brcm]
* After re-enabling WiFi via the privacy switch, you have to reboot to restore function. There is a work around for the default Debian, (and may work with others);
        <code>sudo tee /sys/bus/platform/drivers/dwmmc_rockchip/{un,}bind <<< 'fe310000.dwmmc'</code>
* On extremely rare occasions, the WiFi antenna connection is loose. To fix, simply open up the bottom, re-connect the WiFi antenna cable. This may show up as any of the following symptoms:
** Can't connect to any network, but the network manager software sees the WiFi device, (so it has not been disabled by the Privacy Switch)
** Very limited range, meaning you can make a connection if the Pinebook Pro is next to the WiFi router. But not the next room.
** Unreliable connections, that are also limited by range.

== Bluetooth issues ==

* When connecting a Bluetooth device, such as a Bluetooth mouse, it does not automatically re-connect on re-boot. In the Bluetooth connection GUI, there is a yellow star for re-connect on boot. Use that button to enable a persistent connection. It can be changed back later.
* Bluetooth-attached speakers or headset require the pulseaudio-module-bluetooth package. If not already installed, it can be installed with a package manager or using the following:
<pre>sudo apt-get install pulseaudio-module-bluetooth</pre>
* When using Bluetooth-attached speakers or headset and 2.4Ghz WiFi at the same time, you may experience stuttering of the audio. One solution is to use 5Ghz WiFi if you can. Or you may try using a different 2.4Ghz channel, perhaps channel 1 or the top channel, (11 in the USA, or 13/14 in some other countries).

= Sound issues =

* Many reports of no sound are due to the OS, incorrect settings, or other software problems (eg. PulseAudio). So first test to see if it is a software or hardware problem, by trying another OS via SD card. (For example, if Debian is installed on the eMMC, try Ubuntu on SD.)
* If you cannot get sound from the headphone jack, but can get sound from the speakers, then the headphone / UART console switch may be set to the UART mode. You can open the back and check the position of the switch. If set to UART mode, switch it to headphone mode. See the parts layout for the location and correct position of the switch.
* When using the USB C alternate DisplayPort mode, it is possible that the audio has been re-directed through this path. If your monitor has speakers, see if they work.
* See [https://gitlab.manjaro.org/manjaro-arm/packages/community/pinebookpro-post-install/blob/master/asound.state manjaro-arm/pinebookpro-post-install /var/lib/alsa/asound.state] for some ALSA tweaks.
* See [https://gitlab.manjaro.org/manjaro-arm/packages/community/pinebookpro-audio manjaro-arm/pinebookpro-audio] for how to handle 3.5mm jack plug/unplug events with ACPID.
* Serveral users have reported that one internal speaker had reversed polarity. Thus, sound from the speakers is like an echo effect.
** There is a software fix using alsamixer and then enable either "R invert" or "L invert", however, now the headphones have incorrect audio.
** The permanent fix is to re-wire one speaker, though this requires soldering small wires.
* Sound playback may be affected by the "mirroring" between the right and left channels, which results in distorted sound image. The root cause is the [https://linux.die.net/man/1/alsamixer ALSA mixer] setting named "DAC Stereo Enhancement", which needs to be changed to 0% to fix this issue. Please see [https://forum.pine64.org/showthread.php?tid=12631&pid=87372#pid87372 this forum post] for further information.

= NVMe SSD issues =

Many PineBook Pro users have reported issues with NVMe SSD drives, including random Linux lockups and crashes. Some of these issues are related to the [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=712fa1777207 RK3399's errata] that disables Gen2 (5 GT/s) speed for the PCI Express link used by the NVMe SSD, reducing it down to Gen1 speed (2.5 GT/s). However, Linux distributions that use Linux kernels older than version 5.12 still configure the PCI Express link to run at Gen2 speed, which requires [https://forum.pine64.org/showthread.php?tid=11683 manual reconfiguration] to Gen1 speed in case system instability is experienced. See also this [https://patchwork.kernel.org/project/linux-rockchip/patch/20200423150510.6216-1-pgwipeout@gmail.com/ related discussion]. This issue does not affect distros with recent (newer than May 2021) kernels such as Manjaro ARM which seem to work with no modifications.

Some PineBook Pro users have reported issues with the default settings for the APST (Autonomous Powe State Transition) power saving, which cause an NVMe drive to disappear from the system or lock up after a certain period of time. Please see [https://forum.pine64.org/showthread.php?tid=11337&pid=87711#pid87711 this forum thread] for further information.

= Keyboard and trackpad =

== Random Duplicated Key-Presses ==

Whether caused by an error in the Hailuck Keyboard firmware, or a physical defect in the membrane, the Pinebook Pro keyboard may randomly register some key-presses twice. The solution to this problem is trivial. Simply run the following command:

<code>xkbset bouncekeys 20</code>

If this return the following error:

<code>bash: xkbset: command not found</code>

Or some other similar error, you will need to install the command. It can most likely be found in your distro's repository.

You may substitute some other value for 20 -- this number denoting the time in milliseconds during which successive, duplicate key-presses will be rejected -- with any value of your choice. If you are still receiving duplicates, consider increasing the number -- perhaps by half. If you are consistently writing "aple", try decreasing this number -- perhaps by 25%.

== Keys not registering / missing keys when typing ==
This issue occurs when your thumb or edge of the palm makes contact with left or right tip of the trackpad when you type. This is due to the palm rejection firmware being too forceful. Instead of only disabling the trackpad, so your cursor does not move all over the screen, it disables both the trackpad and the keyboard.

Using Fn+F7 to disable the touchpad will keep it from also disabling the keyboard.

A [[Pinebook_Pro#Trackpad|firmware update]] has been released to address this.

== Key mapping ==
* See this [https://gitlab.manjaro.org/manjaro-arm/packages/community/pinebookpro-post-install/blob/master/10-usb-kbd.hwdb /etc/udev/hwdb.d/10-usb-kbd.hwdb] for some key mapping tweaks

== Pinebook Pro gets stuck after first reboot in Trackpad Firmware Update ==
This refers to the firmware update shown here:
https://github.com/dragan-simic/pinebook-pro-keyboard-updater#update-all-firmware-images
* If the system is not responding after the 1st reboot, it might be easiest to do a system restore or boot an sdcard-only OS, and follow up by running the second step of the trackpad firmware update with a USB keyboard and mouse plugged in
* System restore https://forum.pine64.org/showthread.php?tid=8229
* Firmware update https://github.com/dragan-simic/pinebook-pro-keyboard-updater#update-all-firmware-images

== ANSI Fn + F keys wrong for F9, F10, F11 and F12 ==

There appears to be a minor firmware issue for ANSI keyboard models of the Pinebook Pro. Some discussion and fixes have been proposed;
* Discussion thread [https://forum.pine64.org/showthread.php?tid=8744&pid=57678#pid57678 Fn + F keys screwy for F9, F10, F11 and F12]
* Proposed fix [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater/issues/14#issuecomment-576825396 (ANSI) Fn + F(9-12) has wrong assignment after firmware update #14]

= USB docks & USB C alternate mode video =

The Pinebook Pro uses the RK3399 SoC (System on a Chip). It supports a video pass through mode on the USB C port using DisplayPort alternate mode. This DisplayPort output comes from the same GPU used to display the built-in LCD.

Here are some selection criteria for successfully using the USB C alternate mode for video:
* The device must use USB C alternate mode DisplayPort. Not USB C alternate mode HDMI, or other.
* The device can have a HDMI, DVI, or VGA connector, if it uses an active translater.
* If USB 3 is also desired from a USB dock, the maximum resolution, frame rate and pixel depth is reduced to half the bandwidth. For example, 4K @ 30hz instead of 60hz.
* USB docks that also use USB C alternate mode DisplayPort will always have USB 2 available, (480Mbps, half-duplex).

=Screen=

Also see above about external screen using USB-C adaptor

== After changing builtin LCD resolution, blank screen ==
Some people find that the text or icons are too small, so they attempt to change the resolution of the built-in display. Afterwards, the display is blank.
Use the following to fix when logged into a text console as yourself, pressing Control-Alt-F1 through F6. After listing the resolutions, select the native resolution, (1920x1080 aka 1080p).

<pre>export DISPLAY=:0.0
xrandr -q
xrandr -s [resolution]</pre>

Once the screen resolution is restored, try using the software settings to configure the desired screen scaling.

If the above fix did not work, you can try this:
* Using a text console, (Control-Alt-F1), login with your normal user ID
* Edit the file <code>nano ~/.config/monitors.xml</code>
* Change the "width" value to "1920"
* Change the "height" value to "1080"
* If there is more than one monitor configuration listed, edit that one too. Be careful to make no other changes. If needed, exit without saving and re-edit.
* Save the file and exit.
* Login using the GUI and test
* If you are still loggied in via the GUI, you will have to reboot using <code>sudo shutdown -r now</code>. After the reboot, you should be able to login to the GUI login and have the resolution back to normal.

After restoring the usability of your Pinebook Pro's graphical screen, also see [[Pinebook Pro#Improving readability|this section]] on improving readability and usability.

=Outer Shell=

== Cracks in the plastic ==
There have been multiple reports of cracks in the plastic keyboard and trackpad part of the case. These are generally near:
* Hinges
* USB ports
* Top side, around the corners

This seems to apply to the first batches in 2019. Later versions of the keyboard and trackpad have used better plastic. With replacements now in the Pine64 Store, it's possible to simply order a replacement.

There have been a few reports of cracks in the plastic around the LCD display, but these appear to be less common. There are replacement LCDs with top cases available in the Pine64 Store.

[[Category:PineBook Pro]][[Category:Guide]]

Quartz64 Development

2022-04-08T12:32:04Z

Strit: **Upstreaming Status** update VOP2 to version 10

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=630407]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=612521]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code> and <code>rkvdec</code>, using <code>v4l2-requests</code>
| Necessary device tree changes for the Hantro VPU [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]. rkvdec hardware has been updated compared to rk3399 and may require driver changes.
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233&archive=both]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A, Pinenote
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk35/ebc-drm-v5 here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>naneng-combphy</code>
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7160820d742a16313f7802e33c2956c19548e488]. Still requires DTS changes
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-04-08T12:30:20Z

Strit: **Upstreaming Status** change color of combophy section

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=626925]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=612521]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code> and <code>rkvdec</code>, using <code>v4l2-requests</code>
| Necessary device tree changes for the Hantro VPU [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]. rkvdec hardware has been updated compared to rk3399 and may require driver changes.
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233&archive=both]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A, Pinenote
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk35/ebc-drm-v5 here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>naneng-combphy</code>
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7160820d742a16313f7802e33c2956c19548e488]. Still requires DTS changes
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-04-08T12:29:31Z

Strit: **Upstreaming Status** Combophy Naneng was applied as of 5.18

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=626925]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=612521]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code> and <code>rkvdec</code>, using <code>v4l2-requests</code>
| Necessary device tree changes for the Hantro VPU [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]. rkvdec hardware has been updated compared to rk3399 and may require driver changes.
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233&archive=both]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A, Pinenote
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk35/ebc-drm-v5 here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|Linux Mainline
| <code>naneng-combphy</code>
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7160820d742a16313f7802e33c2956c19548e488]. Still requires DTS changes
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-03-10T15:28:54Z

Strit: update status of Combo PHY / Naneng

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=608673]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=612521]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code> and <code>rkvdec</code>, using <code>v4l2-requests</code>
| Necessary device tree changes for the Hantro VPU [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]. rkvdec hardware has been updated compared to rk3399 and may require driver changes.
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Rockchip Tree
| PineNote
| Will be in Mainline in 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/mmind/linux-rockchip.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk35/ebc here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|Linux-Next[https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/phy/rockchip?h=next-20220310&id=7160820d742a16313f7802e33c2956c19548e488]
| <code>naneng-combphy</code>
| Still requires DTS changes
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-02-09T09:10:30Z

Strit: /* Upstreaming Status */ update gpu patchset to v5

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=608673]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=612521]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code>, using <code>v4l2-requests</code>
| Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=609809]
| PineNote
| [[User:smaeul]] wrote a device tree using mainline bindings [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here].
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=601993]
| <code>naneng-combphy</code>
|
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-01-30T08:53:57Z

Strit:

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=608673]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=586441]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code>, using <code>v4l2-requests</code>
| Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=609809]
| PineNote
| [[User:smaeul]] wrote a device tree using mainline bindings [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here].
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=601993]
| <code>naneng-combphy</code>
|
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-01-30T08:52:19Z

Strit:

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=608673]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=586441]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code>, using <code>v4l2-requests</code>
| Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=609809]
| PineNote
| [[User:smaeul]] wrote a device tree using mainline bindings [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here].
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=601993]
| <code>naneng-combphy</code>
|
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-01-30T08:49:49Z

Strit: /* Upstreaming Status */ Add PineNote device tree patchset

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=608673]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=586441]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code>, using <code>v4l2-requests</code>
| Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:#F99; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=609809]<[/sub>
| PineNote
| [[User:smaeul]] wrote a device tree using mainline bindings [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here].
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=601993]
| <code>naneng-combphy</code>
|
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-01-26T16:13:11Z

Strit: /* Upstreaming Status */ Update to v4 of VOP2 patchset

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=608673]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=586441]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code>, using <code>v4l2-requests</code>
| Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| PineNote
| [[User:smaeul]] wrote a device tree using mainline bindings [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here].
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=601993]
| <code>naneng-combphy</code>
|
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2022-01-23T10:16:25Z

Strit: /* Upstreaming Status */ update usb2phy status to Linux Mainline 5.17

This page documents the current status of software support for the [[Quartz64]] single-board computer, and provides links to resources to help prospective contributors get started. Information is kept current on a best-effort basis as various patches get accepted into the kernel.

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=598177]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=586441]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code>, using <code>v4l2-requests</code>
| Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| PineNote
| [[User:smaeul]] wrote a device tree using mainline bindings [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here].
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=536233]
| <code>rk817-charger</code>
| In the BSP tree this is handled by [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_battery.c rk817_battery.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/power/supply/rk817_charger.c rk817_charger.c].
| Quartz64 Model A
|-
! scope="row" | Microphone
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-saradc</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=7786da3b5ae167c17f35e22ba35e06006338c2f6]. Headphone jack mic seems to connect to <code>SARADC_VIN2_HP_HOOK</code>, so I'm pretty sure that the dtsi and driver changes are needed for that mic to work
|-
! scope="row" | USB 2.0
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-usb2phy</code>
| As of 5.17[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/drivers/phy/rockchip?h=v5.17-rc1&id=42b559727a45d79c811f493515eb9b7e56016421]
|-
! scope="row" | e-Ink
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| <code>rockchip-ebc</code>
| A DRM driver is available [https://github.com/smaeul/linux/commits/rk356x-ebc-dev here]; also see [[RK3566 EBC Reverse-Engineering]]
|-
! scope="row" | Combo PHY
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=601993]
| <code>naneng-combphy</code>
|
|-
! scope="row" | RGA
| colspan="2" style="background:#F99; text-align:center;"|Needs fixing
| <code>rockchip-rga</code>
| [[User:CounterPillow]] experimentally enabled it[https://gist.github.com/CounterPillow/6bea809f15ada7ddd3a3d7a4994fdc4e] in the device tree and ran gstreamer's v4l2convert through it to test, resulting in a completely garbled output.
|-
! scope="row" | Fan Controller
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>emc2301</code>
| Previous attempts at mainlining: [http://lkml.iu.edu/hypermail/linux/kernel/1306.1/02473.html] and [https://lore.kernel.org/all/20200928104326.40386-1-biwen.li@oss.nxp.com/]. Latest iteration: [https://gitlab.traverse.com.au/ls1088firmware/traverse-sensors/-/commit/1cdec49171ebafcf32b347e7701224144de8620b]
| SOQuartz Blade
|-
! scope="row" | CIF (CSI Camera)
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>video_rkcif</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/media/platform/rockchip/cif]
|
|}

== Current Status ==

The following sections give an overview over the current status of different parts of the board. Some parts are waiting on a driver to be written or ported, others only need various adjustments.

According to pgwipeout, I/O device performance is within expected ranges now.

=== Working ===

* eMMC
* SDMMC0 (SD cards)
* GMAC (Gigabit Ethernet)
* USB 2.0
* SATA 2
* SATA 3
* UART
** UART 0 (Pi-bus)
** UART 1 (Bluetooth)
** UART 2 (Pi-bus, debug)
* Video Decode
** VP8
* Battery
* GPU
* Audio
** Analog audio works
** SPDIF works
** HDMI works
* SPI — works, user needs to modify device tree to add devices
* I2C — works, user needs to modify device tree to add devices

=== Partially Working ===

* PCI-Express Controller — everything but devices that need cache coherency (e.g. dGPUs) should work
** [[User:CounterPillow]] noticed some weirdness with NVMe devices disconnecting during heavy write operations, likely down due to power draw on one of the rails as the same sustained bandwidth could be achieved with a different PCIe device with no issue.
* SDMMC1 (Wi-Fi) — AP6256 working, BL602 needs some work to make it flash firmware
* [https://developer.arm.com/architectures/system-architectures/system-components/arm-generic-interrupt-controller GIC] — needs errata published by Rockchip to get upstream to add device-specific workarounds[https://lore.kernel.org/linux-rockchip/CAMdYzYrQ5f-mv_VmTq_CRf9tR=j3mwRpKHNLmPFgCF9whsGFRw@mail.gmail.com/]
* Video Output — only at 1920x1080p60 and nothing else, very buggy and rough around more than just the edges

=== Confirmed Broken ===

* USB 3.0 — only works with very short cables and depends on the device. This is due to a hardware design issue relating to the coupling capacitors needed for SATA, which shares the same lines as USB 3.0.
** Hardware design changes have been suggested to engineers, it's in their hands now.
* Module autoloading for the Ethernet PHY. The Motorcomm PHY does not have a vendor ID written into the appropriate hardware block, so there is no canonical way to identify the device.

=== Needs Testing ===

* E-Paper — needs EBC driver
* Microphone Input
* CSI — needs CIF driver

== TODO ==

=== ebc-dev Reverse Engineering and Development ===

The [https://gitlab.com/pine64-org/quartz-bsp/linux-next/-/tree/rk356x-ebc-dev driver for the eInk panel] needs to both be reverse engineered and then rewritten as C. In its current form, it is mostly an assembly dump produced by gcc with debug symbols. See [[RK3566 EBC Reverse-Engineering]] for details.

=== Investigate MCU ===

The RK3566 comes with an integrated RISC-V microcontroller (MCU). It communicates with the A55 host through the Mailbox system driven by the rockchip-mailbox driver. Since this MCU would be quite useful for things such as low power standby mode, investigating how it can be turned on and have firmware flashed to it should greatly enhance the power saving features of the PineNote.

=== Mainline U-Boot Work ===

Currently, mainline U-Boot does not have support for the RK3566 SoC used on the Quartz64. That's why we currently use the "downstream" Rockchip U-Boot, which is based on an old version of U-Boot and contains vendor specific patches that have not undergone the same level of code review as they'd have done had they been submitted upstream.

While the lack of ATF sources means that using mainline U-Boot would still require the use of Rockchip provided binaries for the firmware, the mainline U-Boot works needs to be done eventually anyway, and even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Someone needs to get on the task of investigating what minimally needs to be ported to get the board booting with mainline U-Boot, port those changes, and submit them for review.

==== Things that need to be done ====

This list is non-exhaustive as we don't exactly know how much is missing

* Do the <code>rk3568.dtsi</code> refactoring into <code>rk356x.dtsi</code>/<code>rk3568.dtsi</code>/<code>rk3566.dtsi</code> that the kernel did, probably just port the kernel dtsi files for this
* Bring the kernel's Quartz64 DTS into the tree
* Write a <code>quartz64-rk3566_defconfig</code> based on <code>evb-rk3568_defconfig</code>

Stretch Goals:

* Port the Naneng Combo PHY driver to u-boot so we can SATA, USB 3 and PCIe boot
* Look into SPI
* Port the Motorcomm PHY driver to u-boot for networking?
* Port a basic VOP2 driver to get a framebuffer from u-boot

==== List of Useful Resources for this Task ====
* Downstream Rockchip U-Boot repository with Quartz64 specific patches: https://gitlab.com/pgwipeout/u-boot-rockchip/-/tree/quartz64
* Mainline Rockchip custodian U-Boot repository: https://source.denx.de/u-boot/custodians/u-boot-rockchip
* U-Boot Mailing List: https://lists.denx.de/listinfo/u-boot

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (in the future) HDMI audio
* <code>CONFIG_SND_SOC_RK817</code>
** for Analog audio on the Model A
* <code>CONFIG_STMMAC_ETH</code>
** Ethernet
* <code>CONFIG_DWMAC_ROCKCHIP</code>
** Ethernet
* <code>CONFIG_MOTORCOMM_PHY</code>
** Ethernet, set this one to Y, m won't work out of the box as module autoloading does not work for this specific PHY (the vendor ID is zeroed out), alternatively tell users in board-specific setup instructions to force loading the <code>motorcomm</code> module if you set it to m.
* <code>CONFIG_MMC_DW</code>
** MMC/SD
* <code>CONFIG_MMC_DW_ROCKCHIP</code>
** MMC/SD
* <code>CONFIG_PCIE_ROCKCHIP_DW_HOST</code>
** PCIe
* <code>CONFIG_PHY_ROCKCHIP_NANENG_COMBO_PHY</code>
** PHY for PCIe/SATA/USB3, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

== Resources ==
=== Repositories ===

* pgwipeout's kernel tree
** https://gitlab.com/pgwipeout/linux-next/-/tree/quartz64-v5.15-rc1
* BSP based development effort for SPL/U-Boot and Linux
** https://gitlab.com/pine64-org/quartz-bsp
* Image CI pipeline aimed at developers
** https://gitlab.com/pgwipeout/quartz64_ci/
* Rockchip U-Boot
** https://github.com/rockchip-linux/u-boot
* Downstream rockchip-linux kernel tree
** https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux
* Tianocore EDK II port for UEFI on Quartz64
** https://github.com/jaredmcneill/quartz64_uefi
* Mainline U-Boot Port by pgwipeout
** https://gitlab.com/pgwipeout/u-boot-quartz64

=== Other ===

* Rockchip-SoC Patchwork Page
** https://patchwork.kernel.org/project/linux-rockchip/list/
* Rockchip Kernel Mailing List Archive
** https://lore.kernel.org/linux-rockchip/

== Board/SoC Documentation ==
=== Booting ===
==== Boot Order ====
The RK3566 boot ROM will search for a valid ID BLOCK in the following order on the support boot media:

* SPI NOR flash
* SPI NAND flash
* SD-Card
* eMMC

... if this fails, the boot ROM will initialize the USB0 port and wait for a connection from the Rockchip
flash/boot tools.

==== Bootloader Flashing ====

As per pgwipeout's [https://gitlab.com/pine64-org/quartz-bsp/u-boot/-/commit/12d102b86813378af08b086f3b9c13ed8010754c commit message]:
* Make a partition named <code>uboot</code> as partition number 1 at 8 MiB to 16 MiB
* <code>dd if=idblock.bin of=/dev/''<mmc/sd>'' seek=64</code>
* <code>dd if=uboot.img of=/dev/''<mmc/sd>''1</code>

==== BSP Image Layout ====

[[Category:Quartz64]][[Category:Rockchip RK3566]]

Quartz64 Development

2021-09-04T07:47:43Z

Strit: /* Upstreaming Status */ update tdm patchset to v4

Quartz64 Development

2021-08-31T08:44:16Z

Strit: /* Upstreaming Status */ update tdm patchset to v3

Quartz64 Development

2021-08-24T07:56:38Z

Strit: /* Upstreaming Status */ update rk817 battery patchset to v4

Quartz64 Development

2021-08-21T10:59:16Z

Strit: /* Upstreaming Status */ Update to v2 of the rockchip-i2s-tdm patchset

Quartz64 Development

2021-08-17T13:08:46Z

Strit: /* Upstreaming Status */ io-domain got into linux-next, so update the link for that

Quartz64 Development

2021-08-17T13:03:56Z

Strit: /* Upstreaming Status */ gpio-rockchip has been applied in linux-next, so update the link

Quartz64 Development

2021-08-16T05:14:55Z

Strit: update link to gpio patchset to v8

Quartz64 Development

2021-08-12T21:30:30Z

Strit: update link to usb2phy patchset to v2

Quartz64 Development

2021-08-11T11:59:11Z

Strit: pci host controller added to linux-next

Quartz64

2021-08-08T15:42:29Z

Strit: /* Software and OS Image Downloads */

The Quartz64 is the most recent Single Board Computer offering from PINE64, initially released in June of 2021. It is powered by a Rockchip RK3566 Quad-Core ARM Cortex A55 64-Bit Processor with a MALI G-52 GPU.

Key features include a PCIe x4 open ended slot (model A) or m.2 (model B) using one Gen2 lane electrically, and the use of LPDDR4 RAM.

The Quartz64 has three LPDDR4 system memory options: 2GB, 4GB or 8GB. For booting, there is an eMMC module socket (supporting up to 128GB) and microSD slot, as well as a footprint to solder on an SPI flash chip. The board is equipped with HDMI, 1x USB 3.0 type A Host, 3x USB 2.0 Host, Gigabit Ethernet, SATA (model A), GPIO Bus, MiPi DSI interface, e-ink interface (model A), eDP interface (model A), touch Panel interface (model A), MiPi CSI interface, as well as many other device interfaces such as UART, SPI, I2C, for makers to integrate with sensors and other peripherals. Many different Operating Systems (OS) are freely available from the open source community, such as Linux (Ubuntu, Debian, Arch), BSD, and Android.

== Software and OS Image Downloads ==

=== Manjaro ARM ===
[[File:Manjaro.png|right|100px]]

Manjaro ARM is a user friendly rolling release distribution, based on Arch Linux ARM.

==== Manjaro ARM with no desktop ====

* [https://github.com/manjaro-arm/quartz64-bsp-images/releases Weekly images on Github]

== SoC and Memory Specifications ==
* Based on [https://www.rock-chips.com/a/en/products/RK35_Series/2021/0113/1274.html Rockchip RK3566]
[[File:RK3566_icon.png|right]]

=== CPU Architecture ===
* [https://developer.arm.com/ip-products/processors/cortex-a/cortex-a55 Quad-core ARM Cortex-A55@1.8GHz]
* AArch32 for full backwards compatibility with ARMv7
* ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
* Includes VFP hardware to support single and double-precision operations
* ARMv8 Cryptography Extensions
* Integrated 32KB L1 instruction cache and 32KB L1 data cache per core
* 512KB unified system L3 cache
* [https://developer.arm.com/ip-products/security-ip/trustzone TrustZone] technology support

=== GPU (Graphics Processing Unit) Capabilities ===
* [https://developer.arm.com/ip-products/graphics-and-multimedia/mali-gpus/mali-g52-gpu Mali-G52 2EE Bifrost GPU@800MHz]
* 4x Multi-Sampling Anti-Aliasing (MSAA) with minimal performance drop
* 128KB L2 Cache configurations
* Supports OpenGL ES 1.1, 2.0, and 3.2
* Supports Vulkan 1.0 and 1.1
* Supports OpenCL 2.0 Full Profile
* Supports 1600 Mpix/s fill rate when at 800MHz clock frequency
* Supports 38.4 GLOP/s when at 800MHz clock frequency

=== NPU (Neural Processing Unit) Capabilities ===
* Neural network acceleration engine with processing performance of up to 0.8 TOPS
* Supports integer 8 and integer 16 convolution operations
* Supports the following deep learning frameworks: TensorFlow, TF-lite, Pytorch, Caffe, ONNX, MXNet, Keras, Darknet

=== System Memory ===
* RAM Memory Variants: 4GB, 8GB LPDDR4.

=== Network ===
* 10/100/1000Mbps Ethernet
* WiFi 802.11 b/g/n/ac with Bluetooth 5.0 (optional on model A, built in on model B)

=== Storage ===
* microSD - bootable, supports SDHC and SDXC, storage up to 2TB
* USB
** Model A: 2 USB 2.0 host ports, 1 USB 2.0 OTG port, 1 USB 3.0 host port
** Model B: 1 USB 2.0 host port, 1 USB 2.0 OTG port, 1 USB 3.0 host port
* one native SATA 3.0 6Gb/s Port (only on model A, shared with USB 3.0 host port)
* optional eMMC module from 16GB up to 128GB

=== Expansion Ports ===
* HDMI
* eDP - 4 lanes of 2.7Gbps, up to 2560x1600@60Hz (only on model A)
* DSI - Display Serial Interface, 4 lanes MiPi, up to 1440P on model A, 2 lanes MiPi, up to 1080p on model B
* CSI - CMOS Camera Interface, 4 lanes MiPi up to 8 mega pixel on model A, 2 lanes MiPi up to 5 mega pixel on model B
* TP - Touch Panel Port, SPI with interrupt on model A
* RTC - Real Time Clock Battery Connector
* VBAT - Lithium Battery Connector with temperature sensor input on model A
* Wifi/BT Module Header - SDIO 3.0 and UART on model A, build in Wifi/BT Module on model B
* 2x20 pins "Pi2" GPIO Header on model B, 2x10 pins GPO header on model A
* PCIe x4 open ended slot on model A, m.2 slot on model B, one Gen2 lane due to SoC constraints

The PCIe implementation on the RK3566 is much more compatible with a wide range of devices compared to the one on the RK3399 used on the ROCKPro64. This means a lot more devices should work (excluding dGPUs due to a lack of cache snooping ability). As an example, PCIe-to-PCI bridges work, whereas they didn't on the ROCKPro64.

==== Combo PHYs ====

[[File:rk3566 phy.png]]

Several of the I/O options on the RK3566 used in the Quartz64 are multiplexed, meaning that they cannot be used at the same time. The above diagram illustrates how they are connected.

In particular, USB 3.0 and the SATA connector on the board are mutually exclusive, and the PCI-e 2.0 lane can be reconfigured into a second SATA port, though an adapter cable needs to be fashioned for this to be useful.

=== GPIO Pins (Quartz64 Model A) ===

Attention! GPIOs are 3.3V!

{| class="wikitable plainrowheaders" border="1"
! scope="col" style="width:20em;" | Assigned To
! scope="col" | Pin Nr.
! scope="col" | Pin Nr.
! scope="col" style="width:20em;" | Assigned To
|-
| style="text-align:right;"| 3.3 V
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 1
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 2
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| I2C3_SDA_M0 a,b
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 3
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 4
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| I2C3_SCL_M0 a,b
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 5
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 6
| style="text-align:left;"| GND
|-
| style="text-align:right;"| CPU_REFCLK_OUT
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 7
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 8
| style="text-align:left;"| UART2_TX_M0_DEBUG
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 9
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 10
| style="text-align:left;"| UART2_RX_M0_DEBUG
|-
| style="text-align:right;"| SPI1_MOSI_M1
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 11
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 12
| style="text-align:left;"| UART0_TX a
|-
| style="text-align:right;"| SPI1_MISO_M1
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 13
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 14
| style="text-align:left;"| UART0_RX a
|-
| style="text-align:right;"| SPI1_CLK_M1
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 15
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 16
| style="text-align:left;"| GND
|-
| style="text-align:right;"| SPI1_CS0_M1
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 17
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 18
| style="text-align:left;"| SPDIF_OUT c
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 19
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 20
| style="text-align:left;"| 3.3V
|}

====Notes====
<ol style="list-style-type:lower-alpha">
<li>can be a PWM pin</li>
<li>pulled high to 3.3V through 2.2kOhm resistor</li>
<li>low-pass filtered with cutoff of 220 MHz</li>
</ol>

Source: Page 28 of [https://wiki.pine64.org/images/3/31/Quartz64_model-A_schematic_v1.0_20201215.pdf the board schematics].

== Quartz64 Board Information, Schematics, and Certifications ==
* Model "A" Baseboard Dimensions: 133mm x 80mm x 19mm
* Input Power: DC 12V @ 3A 5.5mmOD/2.1mmID center-positive Barrel DC Jack connector

* Quartz64 Model "A" SBC Schematic and PCB Board Resource:
** [https://files.pine64.org/doc/quartz64/Quartz64_model-A_schematic_v2.0_20210427.pdf Quartz64 Model "A" SBC Schematic ver 2.0 20210427 PDF file]
** [https://files.pine64.org/doc/quartz64/Quartz64_model-A_V2.0_connector_placement.pdf Quartz64 Model "A" SBC PCB Connector placement PDF file]

* Model "B" Baseboard Dimensions: 85mm x 56mm x 18.8mm
* Input Power: DC 5V @ 3A 3.5mmOD/1.35mmID Barrel DC Jack connector

* Quartz64 Model "B" SBC Schematic and PCB Board Resource:
** Quartz64 Model "B" SBC Schematic not yet available
** [https://files.pine64.org/doc/quartz64/Quartz64%20model-B%20PCB%20placement.pdf Quartz64 Model "B" SBC PCB Connector placement PDF file]

* Certifications:
** Disclaimer: Please note that PINE64 SBC is not a "final" product and in general certification is not necessary. However, PINE64 still submit the SBC for FCC and CE certification and obtain the certificates to proof that SBC board is capable on passing the testing. Please note a final commercial product needs to performs its owns testing and obtains its owns certificates.
** [https://files.pine64.org/doc/cert/Quartz64%20Model-A%20CE%20certification-S21051101701001.pdf Quartz64 model-A FCC Certificate]
** [https://files.pine64.org/doc/cert/Quartz64%20Model-A%20FCC%20certification-S21051101702001.pdf Quartz64 model-A CE Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3566 SoC information:
** [https://files.pine64.org/doc/quartz64/Rockchip%20RK3566%20Datasheet%20V1.0-20201210.pdf Rockchip RK3566 ver 1.0 datasheet, already got release permission from Rockchip]
* LPDDR4 (200 Balls) SDRAM:
** [https://files.pine64.org/doc/datasheet/rockpro64/SM512M32Z01MD2BNP(200BALL).pdf Micron LPDDR4 Mobile LPDDR4 Datasheet]
* eMMC information:
** [https://files.pine64.org/doc/rock64/PINE64_eMMC_Module_20170719.pdf PINE64 eMMC module schematic]
** [https://files.pine64.org/doc/rock64/usb%20emmc%20module%20adapter%20v2.pdf PINE64 USB adapter for eMMC module V2 schematic]
** [https://files.pine64.org/doc/rock64/USB%20adapter%20for%20eMMC%20module%20PCB.tar PINE64 USB adapter for eMMC module PCB in JPEG]
** [https://files.pine64.org/doc/datasheet/pine64/E-00517%20FORESEE_eMMC_NCEMAM8B-16G%20SPEC.pdf 16GB Foresee eMMC Datasheet]
** [https://files.pine64.org/doc/datasheet/pine64/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 32GB/64GB/128GB SanDisk eMMC Datasheet]
* SPI NOR Flash information:
** [https://files.pine64.org/doc/datasheet/pine64/w25q128jv%20spi%20revc%2011162016.pdf WinBond 128Mb SPI Flash Datasheet]
** [https://files.pine64.org/doc/datasheet/pine64/GD25Q128C-Rev2.5.pdf GigaDevice 128Mb SPI Flash Datasheet]
* E-ink Panel information:
** [https://files.pine64.org/doc/quartz64/Eink%20P-511-754-V3_ES103TC1%20Specification%20V3.0(Signed)-20190702.pdf Eink 10.3" 1872x1404 ES103TC1 Flex Panel Specification]
** [https://files.pine64.org/doc/quartz64/Eink%20P-511-828-V1_ED103TC2%20Formal%20Spec%20V1.0_20190514.pdf Eink 10.3" 1872x1404 ES103TC1 Glass Panel Specification]
* LCD Touch Screen Panel information:
** [https://files.pine64.org/doc/datasheet/pine64/FY07024DI26A30-D_feiyang_LCD_panel.pdf 7.0" 1200x600 TFT-LCD Panel Specification]
** [https://files.pine64.org/doc/datasheet/pine64/HK70DR2459-PG-V01.pdf Touch Panel Specification]
** [https://files.pine64.org/doc/datasheet/pine64/GT911%20Capacitive%20Touch%20Controller%20Datasheet.pdf GOODiX GT911 5-Point Capacitive Touch Controller Datasheet]
* Ethernet PHY information:
** [https://files.pine64.org/doc/datasheet/pine64/rtl8211e(g)-vb(vl)-cg_datasheet_1.6.pdf Realtek RTL8211 10/100/1000M Ethernet Transceiver]
* WiFi/BT module info:
** [https://files.pine64.org/doc/datasheet/rockpro64/AP6256%20datasheet_V1.3_12202017.pdf AMPAK AP6256 11AC WiFi + Bluetooth5.0 Datasheet]]
* Enclosure information:
** [https://files.pine64.org/doc/datasheet/case/playbox_enclosure_20160426.stp Playbox Enclosure 3D file]
** [https://files.pine64.org/doc/datasheet/case/ABS_enclosure_20160426.stp ABS Enclosure 3D file]
** [https://files.pine64.org/doc/datasheet/case/pine64%20Die%20Cast%20casing-final.jpg Outdoor Aluminum Cast Dust-proof IP67 Enclosure Drawing]
* Connector information:
** [https://files.pine64.org/doc/datasheet/pine64/ePH.pdf 2.0mm PH Type connector specification use in Lithium Battery (VBAT) port and RTC Battery port]
** [https://files.pine64.org/doc/datasheet/pine64/0.5FPC%20Front%20Open%20Connector%20H=1.5.pdf 0.5mm Pitch cover type FPC connector specification use in DSI port, TP port and CSI port]

== Development efforts ==

{{SeeMainArticle|Quartz64 Development}}

Information and resources of the ongoing development effort for the Quartz64 can be found on the [[Quartz64 Development]] page, where the current status of various board functions can be found, and whether they have landed in upstream.

* [https://gitlab.com/pine64-org/quartz-bsp Quartz64 BSP Gitlab Page]

== BSP Linux SDK ==

=== BSP Linux SDK ver 4.19 for Quart64 model A SBC ===
* [http://files.pine64.org/SDK/Quartz64/QUARTZ64-model-A_BSP%20Linux.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 24554419aec29700add97167a3a4c9ed
** File Size: 32.67.00GB

== Android SDK ==

=== Android 11 SDK for Quart64 model A SBC ===
* [http://files.pine64.org/SDK/Quartz64/QUARTZ64_SDK_android11.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 77c2ff57ea3372fb04da7fb49e17d12b
** File Size: 79.00GB
** Just the boot blobs (<1MB): [[File:Rk35-blobs.tar.gz]]

=== Android 11 Production Test Build for Quart64 model A SBC ===

==== Android 11 Stock Image [eMMC Boot] using DD method [20210604] ====
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* This is test build that used during product testing
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 8GB eMMC module
** [https://files.pine64.org/os/Quartz64/android/Quartz64_model-A_dd_20210604_stock_android11_emmcboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): e4365753e584d9fce1b8f10f095eede6
*** File Size: 819MB
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/Quartz64/android/Quartz64_model-A_dd_20210604_stock_android11_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 491c5f7744b0ca0b74ae76e607051836
*** File Size: 1.10GB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/Quartz64/android/Quartz64_model-A_dd_20210604_stock_android11_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 47a6f0cdac8bad06cb920743849a8894
*** File Size: 846MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/Quartz64/android/Quartz64_model-A_dd_20210604_stock_android11_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4e2fed6f5db0d55afdc8a142fc0c4fe1
*** File Size: 884MB

==== Android 11 Production Test Build for Quart64 model A SBC [eMMC Boot] using ROCKChip tools method [20210604] ====
* Please unzip first and then using [https://files.pine64.org/os/Quartz64//android/RKDevTool_Release_v2.84.zip Rockchip Android tool ver 2.84] to flash in
* For Windows OS environment, please install the [https://files.pine64.org/os/Quartz64/android/DriverAssitant_v5.1.1.zip DriverAssistant v5.11] driver first
* This is test build that used during product testing
* The OTG port located at top USB 2.0 port on top of USB 3.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
** [https://files.pine64.org/os/Quartz64/android/Quartz64_model-A_20210604_stock_android11_emmcboot.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 800f867fdd0d1b2bd7822c156b6067e3
*** File Size: 812MB

=== Android 11 eink SDK for Quart64 model A SBC ===
* The is the Android SDK build for 10.3" eink panel on Quartz64 model A SBC.
* [http://files.pine64.org/SDK/Quartz64/QUARTZ64-model-A_eink.android11_SDK.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 293a550584298de4fb95ceae18103672
** File Size: 72.88GB
** Just the boot blobs (<1MB): [[File:Rk35-blobs.tar.gz]]

== Troubleshooting ==

=== Stability/Boot Issues With Missing Battery Shunt ===

If there is no battery plugged into the board, the jumper labelled "ON/OFF_BATT" must be in place. If this is set wrong, stability issues such as failures to boot will occur.

=== No Ethernet Connectivity ===

Make sure the kernel is built with <code>CONFIG_MOTORCOMM_PHY</code> set to <code>y</code>. Building it as a module (<code>m</code>) and then relying on module auto-loading is unlikely to work as the PHY chip lacks its manufacturer ID.

=== "Model A" Acrylic Case Doesn't Fit ===

The Quartz64 does not really fit onto the bottom plate of the "Model A" Acrylic Case. This is because the "Mic" connector at the bottom of the board interferes with one of the posts. A workaround is to find out which post that is (you have a 50% chance of guessing it right, accounting for rotating the board) and then filing away the corner of the post pointing inwards by a few millimetres.

An alternate solution may be to place plastic spacers with a smaller outer diameter in between the acrylic bottom plate posts and the SBC board.

[[Category:Quartz64]]

Pinebook Software Releases

2021-08-08T15:35:40Z

Strit: /* Manjaro ARM */

= Linux Image Releases =

'''Special thanks to Sunxi community, ayufan, and longsleep for their contributions'''

Below you will find useful links to various resources and forum threads:
* [https://linux-sunxi.org/Pine_Pinebook Sunxi Pinebook Page]

==Manjaro ARM==
[[File:Manjaro.png|right|100px]]

=== Manjaro KDE ARM Community Build Image [microSD / eMMC Boot] ===
* [https://manjaro.org/downloads/arm/pinebook/arm8-pinebook-kde-plasma/ Direct download from Manjaro]

=== Manjaro MATE ARM Community Build Image [microSD / eMMC Boot] ===
* [https://manjaro.org/downloads/arm/pinebook/arm8-pinebook-mate/ Direct download from Manjaro]

=== Manjaro XFCE ARM Community Build Image [microSD / eMMC Boot] ===
* [https://manjaro.org/downloads/arm/pinebook/arm8-pinebook-xfce/ Direct download from Manjaro]

=== Manjaro Gnome ARM Community Build Image [microSD / eMMC Boot] ===
* [https://manjaro.org/downloads/arm/pinebook/arm8-pinebook-gnome/ Direct download from Manjaro]

=== Manjaro SWAY ARM Community Build Image [microSD / eMMC Boot] ===
* [https://manjaro.org/downloads/arm/pinebook/arm8-pinebook-sway/ Direct download from Manjaro]

== Armbian ==
[[File:armbian.png|right|100px]]

=== Armbian Debian Buster [microSD / eMMC Boot] ===
* Armbian provides a build system and images for Debian/Xenial with BSP kernel and mainline kernel
* DD image (for 8GB microSD card and above)
** [https://redirect.armbian.com/pinebook-a64/ Pinebook Armbian download site]
* To find out more about Armbian and available options please visit their [https://www.armbian.com/pinebook-a64/ site].

=== Armbian Ubuntu Focal XFCE Desktop [microSD / eMMC Boot] ===
* Armbian provides a build system and images for Debian/Xenial with BSP kernel and mainline kernel
* DD image (for 8GB microSD card and above)
** [https://dl.armbian.com/pinebook-a64/Focal_legacy_desktop Pinebook Armbian download site]
* To find out more about Armbian and available options please visit their [https://www.armbian.com/pinebook-a64/ site].

== KALI ==
[[File:Kali.jpeg|right|100px]]

=== KALI Build Image by Defensive Security [microSD / eMMC Boot] [2020.2] ===
* To learn more, please visit the official [https://www.offensive-security.com/kali-linux-arm-images/#2536677610546-d94f090d-c5ea KALI by Defensive Security website]
* DD image (for 8GB microSD card and above)
** [https://images.kali.org/arm-images/kali-linux-2020.4-pinebook.img.xz Direct download from Defensive Security]
*** MD5 (XZ file): 7E3643730D2D287A3726B641A6DA177C
*** File Size: 686MB
* Login with
** username: kali
** password: kali

== AOSC ==
[[File:aosc.png|right|100px]]

* To learn more about AOSC, please visit the official [https://aosc.io/ AOSC website]
* AOSC using LZ4 compression algorithm, please visit the [https://github.com/lz4/lz4 LZ4 github site] for utility
* DD image to eMMC module using USB adapter for eMMC module.
* 8GB microSD card and above or 16GB eMMC module and above
* Login with
** username: aosc
** password: anthon
=== AOSC KDE Community Build Image [microSD / eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/sunxi64/kde/pinebook/ Direct download from AOSC]

=== AOSC GNOME Community Build Image [microSD / eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/sunxi64/gnome/pinebook/ Direct download from AOSC]

=== AOSC MATE Community Build Image [microSD / eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/sunxi64/mate/pinebook/ Direct download from AOSC]

=== AOSC XFCE Community Build Image [microSD / eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/sunxi64/xfce/pinebook/ Direct download from AOSC]

=== AOSC LXDE Community Build Image [microSD / eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/sunxi64/lxde/pinebook/ Direct download from AOSC]

== KDE Neon Image ==
[[File:kde_neon.png|right|100px]]

=== KDE Neon Community Build Image [microSD / eMMC Boot] ===
* DD image (for 8GB microSD card and above)

** [https://files.kde.org/neon/images/pinebook-remix-nonfree/useredition/ Direct download latest release build from KDE Neon Pinebook and 1080P Pinebook]
* Login with
** username: live
** password: live

=== KDE Neon Community Build Image [microSD / eMMC Boot] ===
* DD image (for 8GB microSD card and above)
* For 14.1' and 11.6" Pinebook, please choose "neon-pinebook-remix-useredition-202xxxxx-1500-arm64.img.gz"
* For 1080P 11.6" Pinebook, please choose "neon-pinebook-remix-useredition-202xxxxx-1500-arm64-1080p.img.gz"
** [https://files.kde.org/neon/images/pinebook-remix-nonfree/useredition/ Direct download latest release build from KDE Neon 1080P Pinebook]

== Q4OS ==
[[File:q4os.png|right|100px]]

=== Q4OS Community Build Image [microSD Boot] ===
* Q4OS is advertised as a 'fast and powerful operating system based on the latest technologies while offering highly productive desktop environment'
* To learn more please visit the [https://forum.pine64.org/showthread.php?tid=4506 forum] or official [https://q4os.org/index.html Q4OS website]
* DD image for 14.1" and 11.6" Pinebook (8GB microSD card and above)
** [https://sourceforge.net/projects/q4os/files/stable/ Direct download latest release build from SourceForge and look for q4os-x.x-pinebook.xx.zip]
* DD image for 1080P 11.6" Pinebook (for 8GB microSD card and above)
** [https://sourceforge.net/projects/q4os/files/stable/ Direct download latest release build from SourceForge and look for q4os-x.x-pinebook1080p.xx.zip]
* login with:
** username: adminq
** password: adminq

== DietPi ==
[[File:dietpi.png|right|100px]]

* DietPi is a '''lightweight''', yet '''easy to setup''' and '''feature-rich''' Linux distribution, based on '''Debian'''.
* To find out more about DietPi, please visit the [https://dietpi.com/docs/ official documentation].
* Discuss the Pinebook build on the [https://forum.pine64.org/showthread.php?tid=12512 PINE64 forum thread].
* DD image (for 4 GiB micro SD card and above)
** [https://dietpi.com/downloads/images/DietPi_Pinebook-ARMv8-Buster.7z Direct download from dietpi.com]
* Login with
** Username: '''root'''
** Password: '''dietpi'''

== Slackware ==
[[File:slackware.jpg|right|100px]]

* Slackware is a very old, interesting, convenient and easy distribution.
* Visit the project's website here (https://fail.pp.ua)
* You can follow the ongoing discussion about Slackware on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=9439)
* The Slackware build using LRZ compression algorithm, please visit the [https://github.com/ckolivas/lrzip lrunzip github site] for utility

=== Slackware Aarch64 Miniroot Community Build Image [microSD Boot] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://3space.xyz/pineslarm/ Direct download from developer KRT site and look for slarm64-current-aarch64-base-rootfs-xxxxxxxx-x.x.xx-pinebook-build-xxxxxxxx.img.lrz]
* Login with
** Username : root
** Password : password

=== Slackware Aarch64 XFCE Community Build Image [microSD Boot] ===
* Only work on 1080P 11.6" Pinebook, not applicable to 14.1" and 11.6" Pinebook.
* System with a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://3space.xyz/pineslarm/ Direct download from developer KRT site and look for slarm64-current-aarch64-xfce-rootfs-xxxxxxxx-x.x.xx-pinebook-build-xxxxxxxx.img.lrz]
* Login with
** Username : root
** Password : password

== Netrunner [No Longer Maintained] ==
[[File:netrunner.jpg|right|100px]]

=== Netrunner [20180417] [microSD Boot] ===
* Only work on 14.1" and 11.6" Pinebook, not applicable to 1080P 11.6' Pinebook.
* You can visit the Netrunner website [https://www.netrunner.com/netrunner-for-pinebook/ here]
* DD image:
** [https://sourceforge.net/projects/netrunneros/files/netrunner-arm/pinebook/ Direct download from sourceforge.net]

== RISC_OS [No Longer Maintained] ==
[[File:RISC_OS.png|right|100px]]

=== RISC OS Community Build Image [microSD Boot] [19.02] ===
* Only work on 14.1" and 11.6" Pinebook, not applicable to 1080P 11.6' Pinebook.
* To learn more about RISC OS please visit [https://www.riscosopen.org/ RISC OS website]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
** [https:///files.pine64.org/os/Pinebook/RISCOS/pine14_riscos_1GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4BE5698516FAF8420AEA34A422C20991
*** size: 50MB

= BSD Image Releases =

==NetBSD==
[[File:netbsd.png|right|100px]]

=== NetBSD Community Build Image [microSD Boot] ===
* To learn more about NetBSD please visit [https://www.netbsd.org/ NetBSD main page]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
** [https://www.invisible.ca/arm/ Direct download latest release build from NetBSD by select 64bit - Pinebook]
** size: 345MB
* Console and SSH default login:
** username: root
** password: [none]
* Instructions concerning enabling SSH can be found [https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-ssh here]

==OpenBSD==
[[File:Puffy_mascot_openbsd.png|right|100px]]

=== OpenBSD 6.6-snapshot, Community Build Image (FVWM2 WM) ===
* To learn more about OpenBSD please visit [https://www.openbsd.org OpenBSD main page]
* DD image to microSD card or eMMC module (at least 8GB). Highly recommend using [https://etcher.io/ Etcher]
** https://www.dropbox.com/s/79hpdpehrbbk984/pinebook-2019-11-04.img.tgz.sha256?dl=0 (sha256)
** https://www.dropbox.com/s/yas1glfvvucb9a0/pinebook-2019-11-04.img.tgz?dl=0 (image)
** compressed size: 3.6GB
* Console and SSH default login:
** username: pine64
** username: pine64
** root password: pine64
* If you need more information please ping: https://forum.pine64.org/member.php?action=profile&uid=12423

= Android Image Releases =

== Android 7.x [No Longer Maintained] ==
[[File:android_7.png|right|100px]]

=== Android 7.1 Community Build Image [microSD Boot] by ayufan ===
* Only work on 14.1" and 11.6" Pinebook, not applicable to 1080P 11.6' Pinebook.
* Special thanks to ayufan, Icenowy, lennyraposo, longsleep, lukasz, tkaiser, Xalius and PINE64 community contributors
* Please use good random IO access performance microSD card such as Samsung EVO when try out Android 7.1
* DD image (advise 4GB microSD card and above):
** [https://github.com/ayufan-pine64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-pine-a64-pinebook-x.x.x-xx.img.gz]
* Please allows some time (around 5 minutes) for the initialization process on 1st boot

== Android 6.x eMMC ==
[[File:android_6.png|right|100px]]

=== Android 6.0.1 Stock Image for 14.1" and 11.6" Pinebook [microSD to eMMC] [20170605] ===
* Rootable build, online update (OTA) only work when the build still not root
* LCD resolution is 1366 x 768
* Rooted DD image (advise 4GB microSD card and above):
** [https://files.pine64.org/os/Pinebook/android/android-ver6.0.1-rooted-20170605-pinebook-sd2emmc-lpddr3.img.xz Direct download from pine64.org]
*** MD5 (GZip file): C99BF459C6724BA73F12C532E87A8BA5
*** File Size: 776MB

=== Android 6.0.1 Stock Image for 1080P 11.6" Pinebook [microSD to eMMC] [20181001] ===
* Rootable build
* LCD resolution is 1920 x1080
* Rooted DD image (advise 4GB microSD card and above):
** [https://files.pine64.org/os/Pinebook/android/android-ver6.0.1-rooted-20181001-1080P-pinebook-sd2emmc-lpddr3.img.gz Direct download from pine64.org]
*** MD5 (GZip file): E433A148CEBD743EADE6CAA765331A4B
*** File Size: 595MB

=== Android 6.0.1 Stock Image for 1080P 11.6" Pinebook [microSD boot] [20181001] ===
* Rootable build
* LCD resolution is 1920 x1080
* Please use high performance microSD card for Android boot which request frequent random read access.
* Please ignore warning message regarding SD corrupted on home screen upper left corner
* DD images:
** For 8GB microSD Card
*** [https://files.pine64.org/os/Pinebook/android/android-rooted-ver6.0.1-20181001-1080P-pinebook-sdboot-lpddr3-8GB.img.gz Direct download from pine64.org]
**** MD5 (GZip file): CD27DF6083E6A4A5E7C8B986EB92FAA7
**** File Size: 553MB
** For 16GB microSD Card
*** [https://files.pine64.org/os/Pinebook/android/android-rooted-ver6.0.1-20181001-1080P-pinebook-sdboot-lpddr3-16GB.img.gz Direct download from pine64.org]
**** MD5 (GZip file): 1376AAE8382E96FD7B45B0998A5CD6E9
**** File Size: 703MB
** For 32GB microSD Card
*** [https://files.pine64.org/os/Pinebook/android/android-rooted-ver6.0.1-20181001-1080P-pinebook-sdboot-lpddr3-32GB.img.gz Direct download from pine64.org]
**** MD5 (GZip file): B54E7F323B316750654E385B078AEC58
**** File Size: 867MB
** For 64GB microSD Card
*** [https://files.pine64.org/os/Pinebook/android/android-rooted-ver6.0.1-20181001-1080P-pinebook-sdboot-lpddr3-64GB.img.gz Direct download from pine64.org]
**** MD5 (GZip file): C8DBC6293EB51E58F91E27364C8C587D
**** File Size: 734MB

== /e/ [No Longer Maintained] ==
[[File:e.png|right|100px]]

=== /e/OS Community Build Image p [microSD and eMMC Boot] [20190926] ===
* Only work on 1080P 11.6" Pinebook, not applicable to 14.1" and 11.6" Pinebook.
* To learn more about /e/OS, please visit the [https://e.foundation/ official website]
* Please check out [https://medium.com/@edevelopers.blog/e-os-ports-for-the-pinebook-and-pinephone-596139c76479 this article] on the Pinebook /e/ build.
* For thread diiscussion please visit the [https://forum.pine64.org/showthread.php?tid=7954 PINE64 forum]
* DD image (for 8GB microSD card and above)
** [https://files.pine64.org/os/Pinebook/e/e-n-pinebook_20190926.gz Direct download from pine64.org]
*** MD5 (GZip file): 4DC46A4E3ED2B47F4830E96DFCBBC6D8
*** File Size: 685MB

== Bliss OS [No Longer Maintained] ==
[[File:bliss_os.png|right|100px]]

=== Bliss OS [20170919] [microSD Boot] ===
* Only work on 14.1" and 11.6" Pinebook, not applicable to 1080P 11.6" Pinebook.
* An Open-Source OS, based on Android, for phones, tablets & PCs.
* Multi-Windows Android Build
* You can visit the Bliss OS website [https://blissroms.com/ here]
* DD image:
** [https://files.pine64.org/os/Pinebook/Bliss/Bliss-Pinebook_09.19.17_01.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 6B5BC28D69D575BA5448AD8081A0D356
*** File Size: 943MB
* Use the Taskbar launcher for Desktop mode UI

= Linux BSP SDK =
== Linux BSP [4.0] ==
* [https://files.pine64.org/os/sdk/A64-ver4.0/A64-BSP-4.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 802D7C92D27177CBD17567359F9845A7
** File Size: 4.67GB

== Linux BSP [3.0] ==
* [https://files.pine64.org/os/sdk/A64-ver3.0/A64-BSP-3.0.tgz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 898ACF446851DF3BE7B643F62CE3CE84
** File Size: 4.18GB

== Linux BSP [2.0], kernel [v3.10], with GPL compliance header ==
* [https://files.pine64.org/os/sdk/A64-ver2.0/A64-BSP-2.0-GPL.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 2EE11C9AED246C17995493F213A6A6DA
** File Size: 6.41GB

= Android SDK =
== Android Oreo [v8.1] ==
* [https://files.pine64.org/os/sdk/A64-ver4.0/A64-Android-8.1-SDK.tar.gz Direct Download from pine64.org]
** MD5 (TAR-Gzip file): 7E73672FE84F8CD099264D640E107EA3
** File Size: 28.87.95GB

== Android Nougat [v7.0] ==
* [https://files.pine64.org/os/sdk/A64-ver3.0/A64-Android-7.0-SDK.tgz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 5D23D65BC1AA32B9048F62A4176BD9B3
** File Size: 22.60GB

== Android Marshmallow [v6.0] ==
* [https://files.pine64.org/os/sdk/A64-ver2.0/A64-Android-6.0-SDK.zip Direct Download from pine64.org]
** MD5 (Zip file): 12362D0B63EBF29FC363A50A942346D5
** File Size: 12.17GB

= Mali-400 64-bit Driver =
== Mali-400 64-bit Driver [20160622] ==
* [[Mali_Driver|Mali 64-bit Driver Download]]

= Other Tools =
* [https://drive.google.com/file/d/0B0cEs0lxTtL3VmstaEFfbmU1NFk/view?usp=sharing Allwinner PhoenixCard Bootable SD-Card Creator]
* [https://chinagadgetsreviews.com/download-dragonface-latest-version-v-2-2-5.html Allwinner DragonFace V2.2.5 software that will let you edit and modify A64 Android Build PhoenixCard image]
** [https://mega.nz/#!QxEjmaKB!S5nsVnzXVZg5aJ6qLtPOx1yJDPlbl0Vs4iV9VliRpE8 Direct download at Mega]

= Checking microSD Card Performance and whether it is Counterfeit =
* [https://sosfakeflash.wordpress.com/2008/09/02/h2testw-14-gold-standard-in-detecting-usb-counterfeit-drives/comment-page-3/#comment-9861 H2testw 1.4 – Gold Standard In Detecting USB Counterfeit Drives]
* [https://oss.digirati.com.br/f3/ F3 - an alternative to h2testw]
This will help you to determine if the SD-Card is Counterfeit Drive or not

[[Category:PineBook]]

Pinebook Pro Software Releases

2021-08-08T15:32:28Z

Strit: /* Manjaro ARM */

= Linux OS Image Releases =
For information on how to install these images onto your device, please see the [[NOOB]] Page, which includes information on writing images to the device eMMC or an SD card

== Manjaro ARM ==
[[File:Manjaro.png|right|100px]]

The Manjaro project offers a mainline kernel with patches and modules to support PBPro hardware. To learn more about Manjaro please visit [https://forum.manjaro.org/tags/manjaroarm Manjaro Forum]. You can follow the ongoing discussion about Manjaro on the [https://forum.pine64.org/showthread.php?tid=8207 PINE64 forum].
All images boot from both SD card and the internal eMMC module.

=== Manjaro ARM with KDE Plasma ===

* [https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-kde-plasma/ Direct download from Manjaro]

=== Manjaro ARM with Xfce ===

* [https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-xfce/ Direct download from Manjaro]

=== Manjaro ARM with Gnome ===

* [https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-gnome/ Direct download from Manjaro]

=== Manjaro ARM with Sway ===
* [https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-sway/ Direct download from Manjaro]

=== Manjaro ARM with no desktop ===
* [https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-minimal/ Direct download from Manjaro]

== Armbian ==
[[File:armbian.png|right|100px]]

To find out more about Armbian and available options please visit their [https://www.armbian.com/pinebook-pro/ site].

=== Armbian Ubuntu Focal with Xfce (mainline kernel) ===

Armbian provides a mainline kernel build images for Ubuntu Focal with Xfce Desktop. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://dl.armbian.com/pinebook-pro/Focal_current_desktop Armbian's Pinebook Pro Ubuntu Focal Xfce]

=== Armbian Ubuntu Focal with Gnome (mainline kernel) ===

Armbian provides a mainline kernel build images for Ubuntu Focal with GNOME Desktop. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://redirect.armbian.com/region/NA/pinebook-pro/Focal_current_gnome]

=== Armbian Ubuntu Focal with Xfce (legacy kernel) ===

Armbian provides a legacy kernel 4.4 build images for Ubuntu Focal with Xfce Desktop. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://dl.armbian.com/pinebook-pro/Focal_legacy_desktop Armbian's Pinebook Pro Ubuntu Focal Xfce]

=== Armbian Debian Buster with Xfce (legacy kernel) ===

Armbian provides a legacy kernel 4.4 build images for Debian Buster with Xfce Desktop. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://dl.armbian.com/pinebook-pro/Buster_legacy_desktop Armbian's Pinebook Pro Debian Buster Xfce]

=== Armbian Ubuntu Bionic with Xfce (legacy kernel) ===

Armbian provides a legacy kernel 4.4 build images for Ubuntu Bionic with Xfce Desktop. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://dl.armbian.com/pinebook-pro/Bionic_legacy_desktop Armbian's Pinebook Pro Ubuntu Bionic Xfce Desktop download site]

== Twister OS ==
[[File:Twister_OS.png|right|100px]]

Twister OS Armbian-Reforged with Xfce. It boots from microSD card and from eMMC. For more information on Twister OS, please visit this [https://twisteros.com/ official site]. You can follow the ongoing discussion about Twister OS on the [https://forum.pine64.org/showthread.php?tid=12192 PINE64 forum].

'''Installation'''

* After flashing image, edit /boot/armbianEnv.txt, replace the dtb name with <code>rk3399-pinebook-pro.dtb</code>

'''Download location'''

Get the latest image here: [https://twisteros.com/twisterarmbian.html Direct download latest images from Twister OS's website] (size: 2.8GB)

'''Password'''

asdasd

== Fedora ==
[[File:fedora1.png|right|100px]]

=== Fedora Official ===

Using this [https://nullr0ute.com/2021/05/fedora-on-the-pinebook-pro/ blog post] it is now possible to run Official Fedora on the Pinebook Pro.

'''Notes'''
Upstream Fedora uses SPI flash on the Pinebook Pro to manage uboot.

=== Fedora 34/33/32 Gnome/KDE/Minimal Images ===

Unofficial images based on Fedora, and a [https://copr.fedorainfracloud.org/coprs/aptupdate/pinebook-pro/ copr] repository for kernel and tweaks. It boots from microSD card and from eMMC. To learn more about how they are build [https://github.com/bengtfredh/pinebook-pro-fedora-installer Install script].

'''Download location'''

Get the latest image here: [https://s3.fredhs.net/minio/pinebook-pro-image/ Fedora Pinebook Pro Images]

=== Fedora 32 with Cinnamon ===

This image contains an install of Fedora with [https://cinnamon-spices.linuxmint.com/ Cinnamon] desktop environment. It boots from microSD card and from eMMC. To learn more about Fedora please visit the [https://getfedora.org/ official website].

'''Download location'''

Get the latest image here: [https://builds.armdevelopers.com/pinebook-pro/releases/dev/Fedora32-Cinnamon-Desktop-202009.0.pinebook-pro.img.xz Fedora 32 Pinebook Pro Image]

'''Username and password'''

root/fedora

=== Fedora 32 with KDE ===

This image contains an install of Fedora with [https://kde.org/ KDE aka Plasma] desktop environment. It boots from microSD card and from eMMC. To learn more about Fedora please visit the [https://getfedora.org/ official website].

'''Download location'''

Get the latest image here: [https://builds.armdevelopers.com/pinebook-pro/releases/dev/Fedora32-KDE-Desktop-202009.0.pinebook-pro.img.xz Fedora 32 Pinebook Pro Image]

'''Username and password'''

root/fedora

=== Fedora 32 with Xfce===

This image contains an install of Fedora with [https://xfce.org/ Xfce] desktop environment. It boots from microSD card and from eMMC. To learn more about Fedora please visit the [https://getfedora.org/ official website].

'''Download location'''

Get the latest image here: [https://builds.armdevelopers.com/pinebook-pro/releases/dev/Fedora32-Xfce-Desktop-202009.0.pinebook-pro.img.xz Fedora 32 Pinebook Pro Image]

'''Username and password'''

root/fedora

=== Fedora 32 with Gnome ===

This image contains an install of Fedora with [https://www.gnome.org/gnome-3/ GNOME 3] desktop environment. It boots from microSD card and from eMMC. To learn more about Fedora please visit the [https://getfedora.org/ official website].

'''Download location'''

Get the latest image here: [https://builds.armdevelopers.com/pinebook-pro/releases/dev/Fedora32-Workstation-202009.0.pinebook-pro.img.xz Fedora 32 Pinebook Pro Image]

'''Username and password'''

root/fedora

== Arch Linux ARM ==
[[File:Archlinux-logo.png|right|100px]]

Arch Linux ARM root filesystem customized for the Pinebook Pro. Instructions are included for installation on microSD card, eMMC module and NVME SSD.

'''Download location'''

[https://github.com/SvenKiljan/archlinuxarm-pbp/releases/latest Get the latest image from GitHub] (size: 591 MB).

'''Installation'''

Make sure to thoroughly read the [https://github.com/SvenKiljan/archlinuxarm-pbp/blob/main/README.md readme], [https://github.com/SvenKiljan/archlinuxarm-pbp/blob/main/README.md installation instructions] and [https://github.com/SvenKiljan/archlinuxarm-pbp/blob/main/FAQ.md FAQ].

'''Username and password'''

The default Arch Linux ARM user credentials.

Username: alarm

Password: alarm

The password for the root account is 'root'.

== postmarketOS ==
[[File:PostmarketOS logo.png|right|100px]]

Official postmarketOS build with the GNOME desktop for the Pinebook Pro. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://images.postmarketos.org/pinebookpro/ Direct download latest images from postmarketOS] (size: 400 MB)

'''Username and password'''

demo/demo

or:

demo/147147

==Kali Linux==
[[File:Kali.jpeg|right|100px]]

=== Kali Linux prebuilt OS images for Pinebook Pro===

Official pre-built OS images of Kali Linux for the Pinebook Pro featuring all tools you'd expect from the distribution. It boots from microSD card and from eMMC.

'''Download location'''

Get the latest image here: [https://www.offensive-security.com/kali-linux-arm-images/ Direct download latest images from Offensive Security's website] (size: 2.0 GB)

'''Username and password'''

kali/kali

== Q4OS ==
[[File:q4os.png|right|100px]]

Q4OS is advertised as a 'fast and powerful operating system based on the latest technologies while offering highly productive desktop environment'. It boots from microSD card and from eMMC. To learn more please visit the [https://forum.pine64.org/showthread.php?tid=8385 PINE64 forum] or official [https://q4os.org/index.html Q4OS website].

'''Download location'''

Get the latest image here: [https://sourceforge.net/projects/q4os/files/testing/ Direct download latest release build from SourceForge]

'''Username and password'''

User account and password are created on first run.

== DietPi ==
[[File:dietpi.png|right|100px]]

* DietPi is a '''lightweight''', yet '''easy to setup''' and '''feature-rich''' Linux distribution, based on '''Debian'''.
* To find out more about DietPi, please visit the [https://dietpi.com/docs/ official documentation].
* Discuss the Pinebook build on the [https://forum.pine64.org/showthread.php?tid=14061 PINE64 forum thread].
* DD image (for 4 GiB micro SD card and above)
** [https://dietpi.com/downloads/images/DietPi_PinebookPro-ARMv8-Buster.7z Direct download from dietpi.com]
* Login with
** Username: '''root'''
** Password: '''dietpi'''

== openSUSE ==
[[File:opensuse-distribution.png|right|100px]]

'''Download location'''

Get the latest openSUSE Tumbleweed images for Pinebook Pro here: [https://en.opensuse.org/HCL:Pinebook-Pro-RK3399]

= BSD =

==NetBSD==
[[File:netbsd.png|right|100px]]

The image boots from microSD card and from eMMC. To learn more about NetBSD please visit [https://www.netbsd.org/ NetBSD main page]

'''Download location'''

Get the latest image here: [http://www.armbsd.org/arm/ Direct download from NetBSD]

'''Installation'''

Instructions concerning enabling SSH can be found [https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-ssh here].

'''Username and password'''

root/(none)

==OpenBSD==
[[File:Puffy_mascot_openbsd.png|right|100px]]

The image boots from microSD card and from eMMC. To learn more about OpenBSD, please visit [https://www.openbsd.org/ OpenBSD main page]

'''Download location'''

ARM64 images, (including support for Pinebook Pro), can be found here [https://www.openbsd.org/arm64.html OpenBSD arm64]

= Linux Installer Releases =

== Manjaro ARM ==
[[File:Manjaro.png|right|100px]]

The [https://gitlab.manjaro.org/manjaro-arm/applications/manjaro-arm-installer manjaro-arm-installer] script is intended to install Manjaro ARM directly to SD/eMMC cards without the need for images (including LXQT, Mate & CuboCore editions, as well as full disk encryption). Running on a Linux x86 computer, it can install Manjaro ARM directly to an empty eMMC using an eMMC to USB adapter. The script can also be run from SD to install an image to the eMMC.

== Debian ==
[[File:debian.png|right|100px]]

* Uses only the upstream kernel and firmware without special patches
* No graphical display yet, works only through serial console
* Requires adding the non-free component to your /etc/apt/sources.list file and installing the "firmware-linux" package for Wi-Fi and Bluetooth support
* Installer is loaded into RAM, can install onto the same media from which it’s booted
* Supports automatic partitioning and full disk encryption through LVM
* Installer currently doesn't install the bootloader, leaving the installed system in an unbootable state until it's manually added

[https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/ The relevant files are built daily here] and may sometimes be unavailable if the build system is having issues. The "README.concatenateable_images" file provides instructions on how to combine the partition.img.gz file with the firmware.pinebook-pro.rk3399.img.gz file in order to create a DD-able image.

The official images are '''not''' recommended yet until the display begins working and the installer properly installs the bootloader. Most users will want to see [[Pinebook Pro Debian Installer|Daniel Thompson's Debian Installer]] instead.

== Gentoo ==
[[File:GentooLogo.png|right|100px]]

There is a script that prepares a Gentoo arm64 stage 3 tarball for the Pinebook Pro. The script takes care of device specifics like an optimized make.conf, an overlay that provides kernel and firmware amongst others, and other miscellaneous fixes.

'''Installation'''

* The usual tarball setup as per [https://wiki.gentoo.org/wiki/Handbook:AMD64 Gentoo Handbook] is left to the user.
* Forum thread with instructions at https://forum.pine64.org/showthread.php?tid=8765

== Kali Linux ==
[[File:Kali.jpeg|right|100px]]

There is a script to create official Kali Linux OS images for the Pinebook Pro. The script carries out the build process in entirety and is Pinebook Pro specific.

'''Installation'''

* Please pull the latest [https://gitlab.com/kalilinux/build-scripts/kali-arm/blob/master/pinebook-pro.sh Kali Linux install script] from the project's GitLab.
* For more information regarding building the OS image please read the README instruction at https://gitlab.com/kalilinux/build-scripts/kali-arm/blob/master/README.md

== K1ss OS ==
[[File:K1ss.png|right|100px]]

There is a repository containing an unofficial port of KISS Linux to AARCH64. The tarball is built for generic aarch64, currently being tested on the Pinebook Pro. You can follow the ongoing discussion about K1ss Linux on the [https://forum.pine64.org/showthread.php?tid=9304 PINE64 forum].

'''Installation'''

* Please pull the latest [https://github.com/jedavies-dev/kiss-aarch64 K1ss Linux install script] from the project's GitHub.

== NixOS ==
[[File:nixos.png|right|100px]]

You can follow the ongoing discussion about NixOS on the [https://forum.pine64.org/showthread.php?tid=10524 PINE64 forum]. There is a good chance we will see Tier 1 support for aarch64, including the Pinebook Pro, in 2021 (see https://github.com/NixOS/rfcs/pull/87).

'''Installation'''

* This is instructions to install NixOS on the Pinebook Pro: https://nixos.wiki/wiki/NixOS_on_ARM/PINE64_Pinebook_Pro
* Please pull the latest [https://github.com/samueldr/wip-pinebook-pro samueldr's repository ] from the project's GitHub.
* [[NixOS Tutorials]]

== SkiffOS ==
[[File:SkiffOS-Icon-1.png|right|100px]]

'''Installation'''

* Instructions to build/install on the Pinebook Pro: https://github.com/skiffos/SkiffOS/tree/master/configs/pine64/book
* Please pull the latest version from the project's GitHub.
* Compiling the boot image takes approximately 30 minutes.
* Easily configure the kernel, compiler, etc with Buildroot.
* Pre-built ISOs will be available with the upcoming 2021.02 release.

[[Category:PineBook Pro]]

PineTab

2021-08-08T15:28:34Z

Strit: /* Manjaro ARM */

{{warning|1=IMPORTANT INFORMATION for '''Early Adopters''' - please [[PineTab/Early-Adopter|'''CLICK HERE''']] - some '''known issues''' are listed there}}

The PineTab is a 10" tablet created by Pine64.

== Specifications ==
* '''Dimensions:''' 11mm x 175mm x 260mm (Thickness, Width, Height)
* '''Weight:''' 575g (Tablet alone)
* '''Build:''' Plastic
* '''Storage:'''
** 64GB of internal eMMC storage
** MicroSD slot, bootable
** M.2 SSD slot, supports SATA and USB devices only, not NVME (optional)
* '''Cameras:''' 2Mpx Front, 5Mpx Rear
* '''SOC:''' Allwinner A64 Quad Core
* '''CPU:''' 4x ARM A53 1.152GHz
* '''GPU:''' Mali 400 MP2
* '''RAM:''' 2GB LPDDR3
* '''I/O:''' HD Video Out (Mini HDMI), Micro USB 2.0 OTG, USB 2.0 A host, 3.5mm Headphone/Mic combo,
* '''Network:'''
** WiFi (802.11b/g/n, 2.4GHz only)
** Bluetooth 2.1
** M.2 LTE / Cell MODEM card, (optional, and takes place of optional M.2 SSD)
* '''Display:'''
** '''Size:''' 10.1 inches (257mm) diagonal
** '''Type:''' HD IPS capacitive touchscreen, 16M colors
** '''Resolution:''' 1280x800, 16:10 ratio 
* '''Attachments/Accessories:''' Magnetically attached keyboard (optional)
* '''Battery:''' 6000MAh (6Ah)
* '''Misc. features:'''
** Volume rocker
** Speakers and Microphone
** 2.5mm OD 0.7mm ID DC Jack Power (5V 2A) Port

== Keyboard ==
'''Overview:''' The PineTab detachable keyboard features a full function row, FN key functionality, meta key (where the Windows key would be) and all of the keys you need for daily use.

'''FN keys:''': Pause/play (F2), Stop (F3), Previous(F4), Next(F5), Music (F6), Mail (F7), Home (F8), Mute (F9), Vol- (F10), Vol+ (F11), Disable touchpad (F12), NumLock (Insert), Scroll Lock (Delete), PgUp (Up Arrow), PgDn (Down Arrow), Home (Left Arrow), End (Right Arrow), Digital Numpad (7,8,9,0,U,I,O,P,J,K,L,;,M,.,/)

==Versions==
* "pinetab-dev": development version sent to ~100 developers. This one is like the Early Adopter version, but has a different display panel.
* [[PineTab/Early-Adopter|Early Adopter]]: the first hardware revision of the PineTab, which shipped to customers.

[[File:PineTabBoard.jpeg|400px|thumb|right|The insides of the PineTab]]

== PineTab board information, schematics and certifications ==
* PineTab mainboard schematic:
** [https://files.pine64.org/doc/PineTab/PineTab%20Schematic%20v1.2-20191125.pdf PineTab mainboard Released Schematic ver 1.2]
** [https://files.pine64.org/doc/PineTab/PineTab%20Board%20View%20v1.2-20191201-top.pdf PineTab mainboard component placement ver 1.2 - Top View]
** [https://files.pine64.org/doc/PineTab/PineTab%20Board%20View%20v1.2-20191201-bottom.pdf PineTab mainboard component placement ver 1.2 - Bottom View]
* PineTab keyboard schematic:
** PineTab keyboard and Pinebook (Pro) keyboard using same controller and from same engineering source
** [https://files.pine64.org/doc/PineTab/Pinetab%20HB092A%20Keyboard%20Schematic.pdf PineTab Keyboard Schematic]
** [https://files.pine64.org/doc/PineTab/HB092_0884232458_Hynitron_PTP_20200514_662905_Linux_US_BackLight_CRC_175057F5.hex PineTab keyboard firmware code]
** [https://files.pine64.org/doc/PineTab/SH68F83V2.0.pdf PineTab Keyboard Controller Datasheet]

* PineTab certifications:
** [https://files.pine64.org/doc/cert/PineTab%20FCC-SDOC%20Certificate-S20060600404001.pdf PineTab FCC Certificate]
** [https://files.pine64.org/doc/cert/PineTab%20CE-RED%20Certificate-S20060600403.pdf PineTab CE RED Certificate]
** [https://files.pine64.org/doc/cert/PINETAB%20ROHS%20TEST%20REPORT.pdf PineTab ROHS Test Report]

== Datasheets for components and peripherals ==
* Allwinner A64 SoC information:
** [https://files.pine64.org/doc/datasheet/pine64/A64%20brief%20v1.0%2020150323.pdf Allwinner A64 SoC brief introduction]
** [https://files.pine64.org/doc/datasheet/pine64/A64_Datasheet_V1.1.pdf Allwinner A64 SoC Data Sheet V1.1 (Official Released Version)]
** [https://files.pine64.org/doc/datasheet/pine64/Allwinner_A64_User_Manual_V1.0.pdf Allwinner A64 SoC User Manual V1.0 (Official Release Version)]

* X-Powers AXP803 PMU (Power Management Unit) information:
** [https://files.pine64.org/doc/datasheet/pine64/AXP803_Datasheet_V1.0.pdf AXP803 PMIC datasheet]

* LPDDR3 (178 Balls) SDRAM:
** [https://files.pine64.org/doc/datasheet/pinephone/ATL3A1632H12A_mobile_lpddr3_11x11.5_v1.0_1600.pdf Artmem LPDDR3 datasheet]

* eMMC information:
** [https://files.pine64.org/doc/rock64/PINE64_eMMC_Module_20170719.pdf PINE64 eMMC module schematic]
** [https://files.pine64.org/doc/rock64/usb%20emmc%20module%20adapter%20v2.pdf PINE64 USB adapter for eMMC module V2 schematic]
** [https://files.pine64.org/doc/rock64/USB%20adapter%20for%20eMMC%20module%20PCB.tar PINE64 USB adapter for eMMC module PCB in JPEG]
** [https://files.pine64.org/doc/datasheet/pine64/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 64GB SanDisk eMMC Datasheet]

* CMOS camera module information:
** [https://files.pine64.org/doc/datasheet/pinephone/OV5640_datasheet.pdf OV5640 5MP CMOS Image Sensor SoC for Rear Module datasheet]
** [https://files.pine64.org/doc/datasheet/pinephone/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GC2145 2MP CMOS Image Sensor SoC for Front Module datasheet]

* LCD touch screen panel information:
** [https://files.pine64.org/doc/datasheet/pinetab/GT9271.pdf GOODiX GT9271 Capacitive Touch Controller datasheet]
** [https://files.pine64.org/doc/datasheet/pinetab/GT9271_Config_20200818_142030_V66.cfg PineTab GT9271 Capacitive Touch Controller configuration file]

* Lithium battery information:

* WiFi/BT module information:
** [https://files.pine64.org/doc/datasheet/pine64/RTL8723BS.pdf RTL8723BS/RTL8723CS specification]

== Operating Systems ==
The PineTab will automatically boot from microSD if a bootable card is inserted. Although it is technically possible to use any ARM distro (because the PineTab uses the mainline kernel), only few of them will actually be usable on Early Adopters PineTab, due to specifics of working with LCD panel. Among those listed all except for postmarketOS have working builds.

=== UBPorts ===
[[File:Ubports-logo.png|100px]]
The UBPorts Ubuntu Touch is what was preinstalled on the PineTab Early Adopters batch.

It can update itself in System Settings, and also a jenkins daily build can be downloaded at this updated address for the latest daily image:

https://ci.ubports.com/job/rootfs/job/rootfs-pinetab-systemimage/

The last stable builds are also listed and appear to be updated every few weeks.

It should be noted that as of 20th January the latest stable/release candidate and development builds still lacked Bluetooth, Rotation and had the same issues with online accounts etc

Online accounts access have a fix for Google accounts here https://github.com/rubencarneiro/account-plugins/releases

There are however significant updates to the original pinetab image (without the issues above)

The old image appears to be deprecated here
[https://ci.ubports.com/job/rootfs/job/rootfs-pinetab/ here]

In the event that WiFi fails to connect, the USB port can be used with an appropriate dongle to connect for internet using ethernet cable.

=== postmarketOS ===
[[File:PostmarketOS-logo.png|100px]]
postmarketOS extends [https://www.alpinelinux.org/ Alpine Linux] to run on smartphones and other mobile devices.

It offers various user interfaces (Phosh, Plasma Mobile, Sxmo, Plasma Desktop, Gnome 3, Kodi, XFCE4, ...). As of writing, official images are provided with Phosh and Plasma Mobile. The official images come in two flavors, either as demo image to try out postmarketOS, or with the installer.

When using the installer images (recommended), it is possible to:
* encrypt your installation
* install from the SD card to eMMC

Getting postmarketOS for the PineTab:
* [https://postmarketos.org/download/ Download page]
* [https://wiki.postmarketos.org/wiki/PINE64_PineTab_(pine64-pinetab)#Installation Flashing instructions]
* Power users may also create their own image with the distribution's install and development tool <code>pmbootstrap</code>

=== Arch Linux ARM ===
[[File:Archlinux-logo.png|100px]]
Arch Linux ARM with Phosh as the UI selection, maintained by the DanctNIX community.

The latest image can be downloaded [https://github.com/dreemurrs-embedded/Pine64-Arch/releases here]

=== Manjaro ARM ===
[[File:Manjaro-logo.svg|100px]]
The PineTab "Early Adopter" edition is currently the only device supported by Manjaro ARM.

Images with several different environments, including Phosh and Plasma, are available for the "Dev" pre-release can be downloaded [https://osdn.net/projects/manjaro-arm/storage/pinetab/ here]

Images for the Early Adopter version can be downloaded [https://github.com/manjaro-arm/pinetab-images/releases here].
Both Beta releases and weekly unstable builds for Phosh and Plasma Mobile can be found there.

=== Mobian ===
[[File:Debian-logo.png|100px]]
Mobian is a project providing Debian images for mobile devices.

PineTab images can be downloaded [https://images.mobian-project.org/pinetab/ here]. Password is '''1234'''

=== Sailfish OS ===

[[File:SailfishOS logo.png|100px]]

You can get SailfishOS on your with the flash-it script, which will write an image on a SD card. https://github.com/sailfish-on-dontbeevil/flash-it

There is a forum discussion with further information.

http://forum.pine64.org/showthread.php?tid=11850

Many things are still broken but Bluetooth, Audio, Rotation and Keyboard are working.

== Installation instructions ==
For instructions on how to install the operating systems to the eMMC or microSD card see [[PinePhone Installation Instructions]]. The information is almost the same for the PineTab, as it is a very similar device. Do not try to use the PinePhone images though, use the PineTab images linked above.

=== Testing ===
To test an OS, just flash its image onto an microSD card, plug it into PineTab, and reboot.
Note that USB stick won't work.
Also note that you need to "flash", not just copy the file onto the card.
Also remember that you need to unpack image file if it's packed!

You can do it using Ubuntu Touch installed on the PineTab! For now, only Mobian is supported by the guide below.

* First, make sure you have enough free disk space and empty Downloads directory on the PineTab (while not strictly necessary, empty Downloads dir will simplify your typing. You can just move all files from there to another directory).
* Turn off Sleep when idle in the settings. Settings > Battery > Sleep when idle: Never
* Go to the Mobian link above and download compressed image (the one ending with .img.gz) - usual recommendation is to download latest, i.e. lowest one.
* Open terminal and type this in it:
cd Downloads
ls
* It should show you the name of the file you've just downloaded
* This file is compressed, so first you need to uncompress it. Type this into terminal:
gunzip *.gz && echo done
* This command will take some time (you won't see any progress until it's done). It either will succeed (and print "done") and fail (and print why).
* Now, let's have a look at disks. Type this into terminal:
lsblk
* It should show you a tree of disks and their partitions. If you don't have microSD card inserted yet, all of them begin with mmcblk2. Also, some of them have something in the "MOUNTPOINT" column
* Insert microSD card into PineTab. Note that all information on it will be deleted, so don't insert one with valuable information on it!
* type `lsblk` into terminal again.
* Note that now tree of disks has one or more new entries - starting with mmcblk0 - that's partitions of your microSD card.
* Confirm that size of mmcblk0 is close to size of the microSD card, and all lines starting with mmcblk0 have empty "MOUNTPOINT" column.
* now type this:
sudo dd if=`ls` of=/dev/mmcblk0 bs=1M status=progress
* It will take some time, depending on speed of your microSD card and size of image file
* Now, reboot your PineTab - type this into terminal:
sudo reboot
* PineTab should boot from the microSD you've just flashed

== Tips and tricks ==

=== Reset ===

If your PineTab is in unknown state or doesn't want to start: Press power button for 7-8s. It makes a sound and you know it's totally off. 3 seconds after, power button again for 2-3s and it will start to boot.

=== Power Off While Charging ===

When plugging your Pinetab into a charger, it automatically powers on. Use the above "Reset" instruction (holding the power button in for several seconds) to turn it off. This will allow your Pinetab to charge without being powered on.

=== Display rotated 90° on Arch ARM ===
With the following command you can turn the display to landscape:

* echo 1 | sudo tee /sys/class/graphics/fbcon/rotate

This command does not persist a reboot.

== External Links ==
* [https://pine64.com/product/pinetab-10-1-linux-tablet/ The PineTab on the Pine64 store]
* [https://forum.pine64.org/forumdisplay.php?fid=140 The PineTab section of the Pine64 forums]

[[Category:PineTab]] [[Category:Allwinner A64]]

PinePhone Carrier Support

2021-08-08T15:24:49Z

Strit: Added Danish CBB carrier

{{under construction}}

{{hint|MMS currently doesn't work in any distribution on the PinePhone without a [[PinePhone_Carrier_Support#MMS_workarounds|script]]! This means images and group chats will not work in text messages.}}

This page contains hints on setting up cellular network connectivity for specific carriers.
For more general information, see [[PinePhone#Modem_and_carrier_support|Modem and carrier support]]. For the APN settings see [[PinePhone APN Settings]].

= Check compatibility =
To check if the PinePhone is supported on your carrier:

Search for your carrier on [https://www.frequencycheck.com/ frequencycheck.com] and compare the carrier's LTE/GSM/WCDMA frequencies to the PinePhone's supported frequencies (listed in the [https://www.quectel.com/UploadFile/Product/Quectel_EG25-G_LTE_Specification_V1.1.pdf modem specification sheet]).

It is likely that there will be a few frequencies that your carrier uses which are not supported by the PinePhone. Not all of the carrier's frequencies need to be supported by the PinePhone for it to work - as long as ''most'' of them are supported, you will still get good coverage.

= Tested and working carriers =

The following is a list of carriers which has been tested by users and confirmed to be working (excerpt):

== Asia ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
| Japan || SoftBank || Not tested || Unsupported by carrier || No || No || Mobian Phosh, December 2020
|-
| Japan || Rakuten Mobile || Unsupported by carrier || Unsupported by carrier || Yes || Yes || Mobian Phosh, January 2020
|-
| Japan || Rakuten Mobile || Unsupported by carrier || Unsupported by carrier || Yes || No || Manjaro Plasma Mobile February 2021
|-
| Japan || Docomo || Yes || Not tested || Yes || Yes || Mobian Phosh, February 2021
|-
| India || Vodafone / Vi India || Yes || Not tested || Yes || Yes || DanctNIX (Arch Linux ARM) with Phosh, March 2021
|-
| South Korea || KT || Yes || Not tested || Yes || Yes || Manjaro Phosh, June 2021
|}

== Africa ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Test || Test || Yes || Yes || Yes || Yes || TestOS with Phosh, 20201129
|-
|}

== Europe ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Sweden || Telenor SE || Not tested || Not tested || Yes || Not tested || Manjaro Plasma Mobile beta2
|-
| UK || Three || Yes || Not tested || Yes || Yes || Manjaro Plasma Mobile beta2
|-
| UK || Vodafone || Yes || Not tested || Yes || Yes || ALARM & pmOS (Phosh?), modem FW latest - 26 Feb 21
|-
| France || Orange || Yes || Not tested || Yes || Yes || Manjaro Phosh Beta6 and later - 9 march 2021
|-
| France || SFR || Yes || Not tested || Yes || Yes || Manjaro Phosh Beta6 and later - 9 march 2021
|-
| France || Free || Yes || Not tested || Yes || Not tested || ArchLinux - 30 July 2021
|-
| Czech Republic || O2 || Yes (only on 2G) || Not tested || Yes || Yes || Mobian Phosh (20210517 image up to date) - 2 June 2021
|-
| Germany || Congstar || Yes || Not tested || Yes || Yes (IPv4 & IPv6) || Mobian (Megi's kernel 5.13.0-rc4, apt up-to-date) with Phosh, 2021-06-07
|-
| Germany || Telekom || Yes || Not tested || Yes || Not tested || Mobian Phosh (5.10-sunxi64), 2021-07-28
|-
| Germany || O2 / Telefonica || Yes || Not tested || Yes || Not tested || KPlasma
|-
| Hungary || Telekom || Yes || Not tested || Yes || Yes (IPv4) || Manjaro Phosh Beta 12, 2021-07-30
|-
| Denmark || CBB || Yes || Not tested || Yes || Yes || Manjaro Plasma Mobile Beta 5, 2021-06-30
|-
|}

== North America ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| USA || T-Mobile || Yes || No || Yes || Yes ||
* Arch Linux Arm 2020/11/29
* Mobian - Phosh
* Manjaro - KDE Plasma Mobile
|-
| USA || MetroPCS (T-Mobile) || Yes || No || Yes || Yes ||
*Arch Linux Arm (Phosh,SXMO) 2021/04/29
*Manjaro - Phosh 2021/04/29
*Mobian - Phosh 2021/3/20
|-
| USA || T-Mobile || Yes - buggy || No || Yes - buggy || Yes - buggy ||
*Manjaro - Plasma Dev 2020/11/21
*Ubuntu Touch - 2020/11/26
*KDE Neon 2020/11/02
|-
| USA || Mint Mobile (T-Mobile) || Yes || Not tested || Yes || Yes ||
*Mobian - Phosh 2021/3/14
*postMarketOS - Phosh, Sxmo, Plasma Mobile 2021/5/26
*Ubuntu Touch 2021/5/24
|-
| USA || Verizon || Yes || Not tested || Yes || Yes ||
*Mobian - Phosh 2021/3/1
|-
| USA || Verizon || No || No || No || No ||
*Ubuntu Touch 2021/5/24 (You can occasionally get the settings to work with Verizon, but it seems like the settings automatically changes the carrier to the wrong one after a few minutes)
|-
| USA || Verizon || Not tested || Not tested || Yes || Not via gui ||
*Manjaro - KDE Plasma Mobile 2021/5/10
|-
| USA || Verizon || Yes || Not tested || Yes || Not via gui ||
*Manjaro - Phosh 2021/5/31
|-
| USA || Verizon || Yes || Not tested || Yes || Yes ||
*postmarketOS - Phosh 2021/5/31
|-
| USA || Verizon || Yes || Not tested || Yes || Yes ||
*Arch - Phosh 2021/5/31
|-
| Canada || Freedom || Yes || Not tested || Yes || Yes ||
*Arch Pinephone - Phosh (APN: internet.windmobile.ca), 2021/4/25
|-
| USA || FaithWireless (AT&T) || Yes || No || Yes || Yes ||
*Arch Linux Arm - Phosh 2021/04/29 (version 0.10.1-1, see the [[PinePhone_Carrier_Support#AT.26T|AT&T issues]] below.)
|-
| USA || Consumer Cellular (AT&T) || Yes || No || Yes || Yes ||
*Manjaro - Phosh 2021/06/26
|-
| USA || Google Fi (T-Mobile) || Yes || No || Yes || Yes ||
*Arch Linux Arm - Phosh 0.10.2 2021/05/29
|}

== South America ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Test || Test || Yes || Yes || Yes || Yes || TestOS with Phosh, 20201129
|-
|}

== Australia / Oceania ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Test || Test || Yes || Yes || Yes || Yes || TestOS with Phosh, 20201129
|-
|}

== Middle East ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Israel|| Cellcom prepay|| receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-

|-
| Israel|| Golan TC || receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| Partner prepay || receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| Pelephone prepay|| receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| Hot prepay|| receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| 019 prepay|| No || NA ||Bars only || NA || on PmOS Sxmo May 14 2021.
|-

|}

= Special carrier notes =

{{Warning|This section contains providers which do not work or require special settings or actions to work.}}

Some carriers might support only certain frequencies or might require certain settings in Ofono or ModemManager. The following is a list of collected notes for carriers regarding special settings, hints or information:

== USA ==
=== AT&T ===
According to [https://ltefix.com/wp-content/uploads/USA-Major-Carriers-Bands-Frequencies-CA.pdf this page], AT&T's primary bands are 12 and 17 - 700ac and 700 MHz respectively. The PinePhone seems to work out-of-the-box with AT&T. If you transfer a SIM card from another phone you were using with AT&T, you need to activate the PinePhone through [https://www.att.com/buy/wireless/byod/byod AT&T's website]. Calls and SMS messages work. VoLTE is as yet untested.

However, it is likely AT&T will drop support with their network upgrade in the near future like their child company Cricket Wireless already has. [https://www.att.com/ecms/dam/att/consumer/help/pdf/Devices-Working-on-ATT-Network.pdf This page] lists their supported devices for their new network.

=== Consumer Cellular ===

Consumer Cellular is a MVNO that uses both AT&T and T-Mobile networks. On the AT&T network LTE data works without special configuration. If you transfer a SIM card from another phone to the PinePhone, you may need to contact customer support in order for them to register the IMEI association to the correct hardware; in one case it was first incorrectly identified as a Samsung Google Nexus Prime before later being correctly identified by the modem model Quectel EG25-G. Customer support also explicitly enabled VoLTE on the device. After VoLTE instructions on this site were followed and APN instructions on the Consumer Cellular site were followed, VoLTE was confirmed working.

=== Cricket Wireless ===
Cricket wireless is a MVNO that uses AT&T's network. VoLTE was fully supported, but the PinePhone is no longer considered a compatible device in the US by the carrier (as of March 2021).

=== SimpleMobile ===
SimpleMobile is a T-Mobile prepaid MVNO operating in the United States. 4G LTE, VoLTE, data, and SMS all work on the PinePhone after activation. Activation can be done online without extra software or assistance, go to https://www.simplemobile.com/activation/byopcollectsim and make sure you have your SIM card and IMEI ready.

=== Sprint ===
Sprint is currently not supported due to unknown reasons. Any input regarding this issue is highly appreciated.

=== T-Mobile ===
According to [https://ltefix.com/wp-content/uploads/USA-Major-Carriers-Bands-Frequencies-CA.pdf this page],
T-Mobile's primary frequency band for the United States is 12 (700ac MHz).

T-Mobile's bands and protocols are summarized on
[https://www.frequencycheck.com/carriers/t-mobile-united-states this page].

While the PinePhone's modem does support all LTE bands that T-Mobile uses in the US (And is one of the best choices for band support with the PinePhone's modem in the US), VoLTE is still listed as "Under development" by the modem manufacturer. T-Mobile's system also does not list the PinePhone as a compatible device due to this lack of official VoLTE support. The modem is capable of working on T-Mobile with VoLTE support enabled.

=== Verizon ===
According to [https://ltefix.com/wp-content/uploads/USA-Major-Carriers-Bands-Frequencies-CA.pdf this page],
Verizon's primary frequency band for the United States is 13 (700 MHz). Verizon's bands and protocols are summarized on
[https://www.frequencycheck.com/carriers/verizon-wireless-united-states this page]. According to the same page, Verizon might restrict their network to only approved devices.

Some users reported that they were able to activate their Verizon SIM by using an Verizon-approved burner phone and then inserting the SIM into the PinePhone.

=== Google Fi ===
Only T-Mobile service works currently, not US Cellular or Sprint.
The APN is h2g2.
Information from [https://forum.pine64.org/showthread.php?tid=11675&page=7 the forum].

Bear in mind that initial activation of the SIM card is not possible without an Android phone running Google Apps.

It should also be noted that Google uses a non-standard MMS implementation that is unlikely to be supported on the PinePhone at any point.

== Europe ==
=== Telekom Germany ===
With low signal, there may be loud interference noise audible in calls on the receiving end. It has not yet been tested whether or not this problem is carrier specific. An easy fix is extending the modem antenna with aluminum foil (or similar) inside the back cover of the phone.

= Known issues =
Known issues:
* The [https://www.frequencycheck.com/models FrequencyCheck model page] does not list either Pine64 or the PinePhone.
* T-Mobile's system does not list the PinePhone as a compatible device due to the lack of official VoLTE support from the manufacturer, despite the fact that it does work.
* MMS doesn't currently work in any distribution on the PinePhone by default. This means images and group chats will not work in text messages.
* Some providers may allow only certain known devices identified by their [https://en.wikipedia.org/wiki/Type_Allocation_Code Type Allocation Code].

= MMS workarounds =
These scripts allow partial MMS support on a [[PinePhone]]:

* JMMS: [https://git.sr.ht/~amindfv/jmms]
* silvermms: [https://gitlab.com/5ilver/silvermms]
* MMS via Matrix with mmmpuppet: [[PinePhone MMS with Matrix]]

There is a Haskel MMS client. MMS can also be manually composed with mmsd on the command line.

= Resources =
* IMEI - [https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity International Mobile Equipment Identity]

[[Category:PinePhone]]