QuartzPro64 Development

2022-11-10T22:50:46Z

Acj: Adding link to preorder request form

[[File:Quartzpro64_whole_board_top_resized.jpeg|250px|thumb|right|The QuartzPro64 development board]]
[[File:BoardBackSide.jpg|100px|thumb|right|Board back side]]

A '''QuartzPro64 Development''' Wiki page before a '''QuartzPro64''' Wiki page? It's more likely than you think!

This page will be used for both documenting the current development efforts and the board in general, as we don't know yet how a generally available QuartzPro64 will look like so documenting the dev board is probably best left to the development page.

= Obtaining a Development Board =

Request/Register: [https://preorder.pine64.org/#/quartzpro64 https://preorder.pine64.org/#/quartzpro64]

= Upstreaming Status =

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
! scope="row" | Video Output
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>VOP2</code>
| Collabora said they'll work on this. The video output IP on the RK3588 should mostly be the same as the one on the RK356x, but the chip specific stuff will need to be integrated into the vop2 driver.
|-
! scope="row" | Video Input
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rk_hdmirx</code>
| Huge 3600 line driver, but generally seems to be in good condition
|-
! scope="row" | 3D Acceleration
| style="background:#F99; text-align:center;"|Needs writing
| style="background:#F99; text-align:center;"|Needs writing
| <code>panfrost</code>
| Collabora said they'll work on this. New architecture, reportedly needs many changes to the kernel component of Panfrost.
|-
! scope="row" rowspan="4" | Video Decode
| style="background:#F99; text-align:center;"|Needs writing
| style="background:LightYellow; text-align:center;" rowspan="4"|GStreamer only, no ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro</code> using <code>v4l2-requests</code>
| VDPU121 handling 1080p60 H.263/MPEG-4, MPEG-1 and MPEG-2
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkvdec2</code> using <code>v4l2-requests</code>
| Nobody is known to be working on this for now. VDPU346 handling 8K60 H.265, H.264, VP9 and AVS
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkdjpeg</code> using <code>v4l2-requests</code>
| [[User:CounterPillow]] is doing a little work on this. VDPU720 handling JPEG
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>?</code> using <code>v4l2-requests</code>
| Collabora said they'll work on this. VDPU981 handling 4K60 AV1
|-
! scope="row" rowspan="3" | Video Encode
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Driver already exists, only minor changes needed.
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU580
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.265 on VEPU580
|
|-
! scope="row" rowspan="2" | Audio
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=688661]
| <code>rockchip-i2s-tdm</code>
|
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>es8388</code> CODEC
|
|-
! scope="row" | CRU
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=686346]
| <code>clk-rk3588</code>
|
|-
! scope="row" | MMC
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>sdhci-of-dwcmshc</code>
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=bbbd8872825310b14bc6e04250d2cb5edcd55edb]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pinctrl-rockchip</code>
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=fdc33eba11c5919199f3d13dc53571cc7bf19d7d]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-gpio</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc165ba48aaf7d792e99d0c7e4b12e9625bc73e3]
|-
! scope="row" | I2C
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3x-i2c</code>
| Should be the same as RK3399, just needs devicetree work
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spi</code>
| Should be the same as previous SoCs, just needs devicetree work
|-
! scope="row" | PMU
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=687286]
| <code>rk806</code>
| Talks over SPI
|-
! scope="row" | Regulators
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rk860</code>
| Talks over I2C
|-
! scope="row" | GMAC
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>dwmac-rk</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=2f2b60a0ec2826e5a2b2a1ddf68994a868dccbc1]
|-
! scope="row" | Power Domains
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domain</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=6541b424ce1dda616d3946e839f015c984df7a99]
|-
! scope="row" | CAN
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip_canfd</code>
| Not broken out on the QuartzPro64, so we probably won't be the ones porting it
|-
! scope="row" | SPDIF TX
| colspan="2" style="background:#F99; text-align:center;"|May need porting
| <code>rockchip-spdif</code>
| Genuinely just needs the compatible string added, I think, otherwise we're all good. Not broken out on QuartzPro64 dev board
|-
! scope="row" | SPDIF RX
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-spdifrx</code>
| Not broken out on QuartzPro64 dev board
|-
! scope="row" | PCIe
| colspan="2" style="background:#F99; text-align:center;"|May need porting
| <code>rockchip-dw-pcie</code>
| Downstream driver and upstream are quite different, look into how much work actually needs doing. Seems to be the same controller as rk3568 so maybe none?
|-
! scope="row" | NPU
| style="background:#F99; text-align:center;"|Needs porting/writing
| style="text-align:center;"|?
| <code>rockchip-rknpu</code>
|-
! scope="row" | USB 2.0
| colspan="2" style="background:#F99; text-align:center;"|?
| <code>?</code>
|
|-
! scope="row" | USB 3.0
| colspan="2" style="background:#F99; text-align:center;"|?
| <code>?</code>
|
|-
! scope="row" | SATA
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>ahci-dwc</code>
| Just needs the compatible added to the bindings
|-
! scope="row" | Thermal
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=687619]
| <code>rockchip-thermal</code>
|
|}

= Hardware =

[[File:Quartzpro64_soc_and_ram_resized.jpeg|200px|thumb|right|The SoC and RAM packages]]

== General ==

* RK3588 SoC
* 16 GB SK hynix DRAM

== Cooler ==

The board comes with two cooler mounts, a 4-hole mount that appears to be spaced 55x55mm apart, and the ~60mm diagonal "northbridge heatsink" mount the ROCKPro64 and Quartz64 Model A uses.

RK3588 is slightly (<1mm?) taller than the DRAM chips, use a thick enough thermal pad instead of thermal compound.

== UART ==

Plug in the USB-C port labelled "<tt>DEBUG PORT</tt>" on the board to another computer with a USB-A-to-C cable. It will show up as a FT232 USB Serial adapter. Baud rate is as usual 1.5 mbauds or 1500000.

Using <code>dmesg</code>, you should see something like the following:
<pre>
[24784.535804] usb 5-3: new full-speed USB device number 3 using xhci_hcd
[24784.710714] usb 5-3: New USB device found, idVendor=0403, idProduct=6001, bcdDevice= 6.00
[24784.710723] usb 5-3: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[24784.710725] usb 5-3: Product: FT232R USB UART
[24784.710727] usb 5-3: Manufacturer: FTDI
[24784.710728] usb 5-3: SerialNumber: A10LLO86
[24784.723858] usbcore: registered new interface driver usbserial_generic
[24784.723865] usbserial: USB Serial support registered for generic
[24784.725286] usbcore: registered new interface driver ftdi_sio
[24784.725295] usbserial: USB Serial support registered for FTDI USB Serial Device
[24784.725348] ftdi_sio 5-3:1.0: FTDI USB Serial Device converter detected
[24784.725368] usb 5-3: Detected FT232RL
[24784.731685] usb 5-3: FTDI USB Serial Device converter now attached to ttyUSB0
</pre>

Then you can get console output with, for example:

<code>
screen /dev/ttyUSB0 1500000
</code>

== Mounting Holes ==

Can't be bothered to take a precise measurement of all the holes right now, just use [https://www.ebay.com/sch/i.html?kw=pc%20standoff%20kit some PC standoffs] and have the board sit on your desk, it's a dev board after all.

See the PCB layout PDF files, linked in the [https://wiki.pine64.org/wiki/QuartzPro64_Development#Documentation Documentation] section.

== Storage ==

[[File:Quartzpro64_emmc_resized.jpeg|200px|thumb|right|The eMMC on the dev board]]

* Soldered on 64 GB FORESEE eMMC chip, it comes pre-flashed with some Android (you'll even get a brief bit of HDMI output)
* microSD card slot
* 2x SATA 3.0 (molex power connector for it not populated, but easy to remedy)

== Power ==

[[File:Power_and_switch.jpg|100px|thumb|right|Power switch & barrel connector]]

You can provide power to the board via the 12V barrel connector, it's 5.5mm OD/2.1mm ID barrel 'coaxial' type "M" centre-positive, the ROCKPro64 5A power supply from the PINE64 store will work. (TODO: add alternative ways).

There is a hardware flip switch to power up / down the board.

== PMU ==

[[File:Quartzpro64_pmu.jpeg|100px|thumb|right|The PMU]]

2x RK806-2, not RK808 compatible. It's a dual PMU configuration where one PMU is a subordinate of the other.

Verify this once we have access to SDK sources.

[https://git.kernel.org/pub/scm/linux/kernel/git/sre/linux-misc.git/commit/?id=18650ce6630a3f066680e3affab33a11b9f3d14d This may be it], TODO: test it & report.

== Ethernet ==

The RGMII ethernet port (near the SDCARD socket) is working if you use neg2led's linux-quartz64 repo.

The other port (near the sound jack) is hooked to the SoC via PCIe and is currently not working.

= Boot=

The board can boot from the following interfaces:
* SPI
* eMMC
* SD/MMC

TODO: in which priority / order are those boot options tried ?

TODO: Add brickability informations

= Immediate TODOs =

== Enable cpufreq Stuff ==

Current neggles kernel has the CPU at 1.2 GHz, apparently sre has patches to enable cpufreq?

== Add RK3588 Support To VOP2 ==

VOP2 IP on the RK3588 is very similar to the one on the RK356x, but it still needs platform specific code added.

= Ways To Do Things =

== Using rkdeveloptool ==

Use the [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool PINE64 fork of rkdeveloptool].

Connect a USB-C cable to the "DEBUG PORT" USB-C port, and a second to the "DOWNLOAD" USB-C port. '''Cable direction for the latter matters, so if it doesn't show up after entering download mode, try rotating the USB-C connector to the other side!'''

Interrupt the boot by mashing Ctrl+C very quickly on the serial comms, then type <code>download</code> to enter rockusb download mode.

$ rkdeveloptool list

should now show you the device somewhat like this:

'''$ rkdeveloptool list'''
DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=204 Loader

{{Template:note|'''Note:''' If you receive an error about being unable to create the comms object in the following steps, make sure you have the udev rules installed with [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool/-/merge_requests/19 CounterPillow's RK3588 device id patch], install them to <code>/etc/udev/rules.d/</code> and <code>udevadm control --reload</code>}}

Now, we can e.g. show the partitions on the eMMC:

'''$ rkdeveloptool list-partitions'''
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 8192 16383 4194304 security
01 16384 24575 4194304 uboot
02 24576 32767 4194304 trust
03 32768 40959 4194304 misc
04 40960 49151 4194304 dtbo
05 49152 51199 1048576 vbmeta
06 51200 133119 41943040 boot
07 133120 329727 100663296 recovery
08 329728 1116159 402653184 backup
09 1116160 1902591 402653184 cache
10 1902592 1935359 16777216 metadata
11 1935360 1937407 1048576 baseparameter
12 1937408 8310783 3263168512 super
13 8310784 120831935 57610829824 userdata

You can now use <code>rkdeveloptool write-partition partitionname yourfile</code> to overwrite one of the eMMC partitions.

== U-Boot + Kernel On SD, RootFS On eMMC ==

This is the setup [[User:CounterPillow]] currently uses. In short, you'll need a vendor U-Boot on your SD card, with a boot partition on it that contains your <tt>extlinux.conf</tt>, device tree and kernel.

=== Setting Up The SD Card ===

Assuming your SD card is <tt>/dev/sdX</tt>, partition as e.g. follows:

# parted -s /dev/sdX mklabel gpt
# parted -s /dev/sdX mkpart loader 64s 8MiB
# parted -s /dev/sdX mkpart uboot 8MiB 16MiB
# parted -s /dev/sdX mkpart env 16MiB 32MiB
# parted -s /dev/sdX mkpart efi fat32 32MiB 544MiB # increase size as you wish
# parted -s /dev/sdX set 4 boot on

Flash SPL and u-boot:
# dd if=rk3588_spl_loader_v1.06.109.bin of=/dev/sdX1
# dd if=uboot.img of=/dev/sdX2

Then make the filesystem:
# mkfs.vfat -n "efi" /dev/sdX4

Mount it to e.g. <tt>/mnt/sdcardboot</tt>:
# mount /dev/sda4 /mnt/sdcardboot

Put the following in <tt>/mnt/sdcardboot/extlinux/extlinux.conf</tt>:
default l0
menu title QuartzPro64 Boot Menu
prompt 0
timeout 50

label l0
menu label Boot Jank Kernel SDMMC
linux /jank
fdt /dtbs/rockchip/rk3588-evb1-v10.dtb
append earlycon=uart8250,mmio32,0xfeb50000 console=ttyS2,1500000n8 root=/dev/mmcblk0p14 rw rootwait

Copy your kernel to <tt>/mnt/sdcardboot/jank</tt> and your DTB to <tt>/mnt/sdcardboot/dtbs/rockchip/rk3588-evb1-v10.dtb</tt>.

Unmount it, we're done with the SD card.

=== Creating The Root File System ===

First, allocate a file the size of your desired root partition (larger sizes will take longer to transfer, don't make the same mistakes as CounterPillow did), here we choose 16G:
$ fallocate -l 16G rootpart.bin

then, make the filesystem on it. CounterPillow went for ext4 because nobody has ever been fired for using ext4:
$ mkfs.ext4 rootpart.bin

Cool, now mount it:
# mount rootpart.bin /mnt/emmc-root

Now we'll download the Arch Linux ARM generic rootfs tarball and go to town:
$ wget -N http://os.archlinuxarm.org/os/ArchLinuxARM-aarch64-latest.tar.gz{,.sig}
$ curl 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x68b3537f39a313b3e574d06777193f152bdbe6a6' | gpg --import=- # in case you're lacking the key
$ gpg --verify ArchLinuxARM-aarch64-latest.tar.gz.sig # don't you dare skip this
# bsdtar -xpf ArchLinuxARM-aarch64-latest.tar.gz -C /mnt/emmc-root # notice that this is run as root

Then we just need to edit fstab. Get the UUID (not PARTUUID) from lsblk:
$ lsblk -o NAME,SIZE,MOUNTPOINTS,UUID

and put it in <tt>/mnt/emmc-root/etc/fstab</tt> as follows:
UUID=''root-uuid-here'' / ext4 defaults 0 1

Unmount <tt>/mnt/emmc-root</tt>, we're done with it.

=== Flashing The Root File System With RockUSB ===

{{Template:warning|This '''will''' destroy whatever data is on that userdata partition. But you're here to run Linux, not Android, right?}}

Plug one USB-C cable into the debug UART port, the other into the download port. Yes you will need two USB-C cables (or A-to-C cables) for this, get over it.

Plug in your board, reset it while hammering Ctrl+c on the debug UART until you get into a u-boot command line. Now enter the <code>download</code> command.

If your device doesn't show up in <code>lsusb</code> or <code>rkdeveloptool list</code> command, pull out the download USB-C plug, rotate it axially by 180 Euler degrees, and plug it back in.

Next, flash the partition. Depending on the size of it, this can take over an hour:
$ rkdeveloptool write-partition userdata rootpart.bin

=== Booting ===

Unplug the download USB-C cable once done.

Put the SD card in the board. Reset it. You can now boot and your rootfs on eMMC will be mounted and contains an ALARM userland.

To update kernels or the device tree, just shut down the board, take out the SD card, write a new kernel or dtb to it, and plug it back in. No more need for rkdeveloptool, yay.

== Using neg2led's kernel branch ==

If you use the linux-quartz64 branch from neg2led's kernel fork (see Resources for a link). The uSD card reader is working and you can use a partition on it for the root FS. This will eliminate the need to use rkdeveloptool.

Create the additionnal partition:

# parted -s /dev/sdX mkpart root ext4 544MiB 4GiB

Mount it:

# mount /dev/sda4 /mnt/sdcardroot

Extract the ALARM rootfs tarball in there:

# bsdtar -xpf ArchLinuxARM-aarch64-latest.tar.gz -C /mnt/sdcardroot # notice that this is run as root

Find the right device your SD card will be (by booting neg2led's kernel once and looking at the boot log). Then modify "root=" from extlinux/extlinux.conf, for example:

root=/dev/mmcblk1p5

= Resources =

== Kernel ==

* [http://lists.infradead.org/pipermail/linux-rockchip/ The linux-rockchip mailing list archives]
* [https://patchwork.kernel.org/project/linux-rockchip/list/ linux-rockchip patchwork]
* [https://github.com/neg2led/linux-quartz64 neg2led's mainline kernel repository with patches picked from the mailing list]
* [https://git.kernel.org/pub/scm/linux/kernel/git/sre/linux-misc.git/log/?h=rk3588 Sebastian Reichel's rk3588 branch]

== Misc ==

* The quartz64 and quartz-dev channels on the PINE64 chats (bridged IRC, Matrix, Discord and Telegram)
* [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool PINE64 rkdeveloptool fork]
* [https://github.com/CounterPillow/uboot-qp64 CounterPillow's uboot-qp64 repository], used with [https://github.com/rockchip-linux/rkbin/ the official rkbin repository]

== Documentation ==

The various documents relating to the chips and board haven't been publicly released yet, but if you do have a QuartzPro64 board [[User:CounterPillow]] will happily provide the documentation for you if you ask him in the PINE64 chats. We have the following:
* RK3588 TRM Part 1 and Part 2
* RK860 datasheet including register descriptions
* RK806 datasheet including register descriptions
* RK3588 hardware design guide, machine translated to English from Chinese, and the original Chinese copy
* [https://devzone.pine64.org/uploads/d392f228-d53b-11ec-9ab8-fe0395c0c83d/9fee695f-39a4-4858-a58a-c91b86d4fa2c/QuartzPro64-DevBoard-Schematic-V1.0_20220216.pdf QuartzPro64 schematics]
* [https://devzone.pine64.org/uploads/d392f228-d53b-11ec-9ab8-fe0395c0c83d/cf368836-966e-4c3c-9e0d-04a82a705d45/QuartzPro64-DevBoard-PCB-V1.0_20220216_topplace.pdf QuartzPro64 PCB top layout]
* [https://devzone.pine64.org/uploads/d392f228-d53b-11ec-9ab8-fe0395c0c83d/ec260213-d4f7-4c61-ad1f-40ee7b7b7a35/QuartzPro64-DevBoard-PCB-V1.0_20220216_bottomplace.pdf QuartzPro64 PCB bottom layout]

[[Category:Rockchip RK3588]]

PINE64 - User contributions [en]

QuartzPro64 Development