PINE64 - User contributions [en]

QuartzPro64 Development

2023-11-13T20:46:20Z

CameronNemo: /* Storage */ fix grammatical error

[[File:Quartzpro64_whole_board_top_resized.jpeg|250px|thumb|right|The QuartzPro64 development board, front side]]
[[File:BoardBackSide.jpg|250px|thumb|right|Back side of the board]]

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 ==

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

== Upstreaming Status ==

* Upstream Linux kernel DT: https://github.com/torvalds/linux/blob/master/arch/arm64/boot/dts/rockchip/rk3588-quartzpro64.dts
* Upstream U-Boot DT: https://github.com/u-boot/u-boot/blob/master/arch/arm/dts/rk3588-quartzpro64-u-boot.dtsi

{| 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:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=721724]
| <code>hantro</code> using <code>v4l2-requests</code>
| Collabora is working 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:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 6.2[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c619bd4268ff9895760dab303b4eb15ed3d0f7e9]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>es8388</code> CODEC
|
|-
! scope="row" | CRU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>clk-rk3588</code>
| As of 6.2[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=f1c506d152ff235ad621d3c25d061cb16da67214]
|-
! 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:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=749871]
| <code>phy-rockchip-inno-usb2</code>
| There's probably more to USB 2 than just the PHY but this is what I found for now
|-
! 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, done in [https://patchwork.kernel.org/project/linux-rockchip/list/?series=749876]
|-
! 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>
|
|-
! scope="row" | Wifi & Bluetooth
| colspan="2" style="background:#F99; text-align:center;"|?
| <code>?</code>
|
|-
! scope="row" | HWRNG
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-rng</code>
| The code & DT work is easy to port & working
|
|-
! scope="row" | RTC
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>hym8563</code>
| Should only need DT work (see [https://patchwork.kernel.org/project/linux-rockchip/list/?series=736799 here] for an example)
|-
! scope="row" | OTP
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=744118]
| <code>rockchip-otp</code>
|
|-
! scope="row" | SARADC
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=748188]
| <code>rockchip_saradc</code>
|
|}

== Hardware ==

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

=== General ===

* RK3588 SoC (8 cores: 4x A76@2.4GHz + 4x A55@1.8GHz)
* Mali G610MC4 GPU (4x Valhalla cores)
* 16 GB LPDDR4X (SK hynix)
* 64 GB eMMC (Foresee, soldered)
* 1x USB-C (with video-alt mode)
* 1x USB-C (FTDI debug UART, FT232RL)
* 1x USB 3.0
* 2x USB 2.0
* 1x HDMI in
* 2x HDMI out
* 1x PCIe 3.0 slot (open-ended)
* 1x SD / TF card slot
* 2x SATA ports
* 2x Gigabit ethernet (1x from SoC, 1x on PCIe, RTL8211F, RTL8111HS)
* 1x WiFi & BT Module (AMPAK Tech AP6275PR3)
* 2x SMA Antenna
* 2x MIPI DPHY
* 1x MIPI D/C PHY
* 1x MIPI CSI
* 1x PWM Fan header (4 pins)
* 1x RTC battery socket (CR1220, 3V, see [[#Documentation|QuartzPro64 board schematics PDF]], page 21)
* 1x MIC (soldered)
* 1x audio output 3.5mm jack
* Power in via DC 12V

=== 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 QP64 board to another computer with a USB-A-to-C cable.

It will show up as a FT232 USB Serial adapter in <code>lsusb</code>:
<pre>
$ lsusb
[...]
Bus 005 Device 027: ID 0403:6001 Future Technology Devices International, Ltd FT232 Serial (UART) IC
[...]
</pre>

Baud rate is 1.5 mbauds or 1500000.

Ensure you have the driver module loaded:
<pre>
# modprobe ftdi_sio
# lsmod | grep ftdi_sio
ftdi_sio 61440 0
usbserial 53248 1 ftdi_sio
usbcore 290816 7 ftdi_sio,usbserial,xhci_hcd,usbhid,usbkbd,usbmouse,xhci_pci
</pre>

If the above is not working, check the required driver is supported by your kernel, using one of the following commands:
<pre>
$ zgrep FTDI_SIO /proc/config.gz
CONFIG_USB_SERIAL_FTDI_SIO=m
$ grep FTDI_SIO "/boot/config-$(uname -r)"
CONFIG_USB_SERIAL_FTDI_SIO=m
</pre>

Using the <code>dmesg</code> command, 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 from the QP64 with, for example:

<pre>
screen /dev/ttyUSB0 1500000
</pre>

=== Mounting Holes ===

Mounting holes are 3 mm in diameter, so standard standoffs can be used, preferably the 2.5 mm variant. See also the PCB layout PDF files, linked in the [https://wiki.pine64.org/wiki/QuartzPro64_Development#Documentation Documentation] section.

The height from the bottom of the PCB to the top of the USB ports as the tallest components is 18 mm, which can be used as a data point for selecting the suitable standoff length to place some acrylic top cover over the board. However, that doesn't account for the heatsink that needs to be mounted on the RK3588 SoC, for which a suitable rectangular hole can be cut in the top cover.

=== Storage ===

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

* Soldered 64GB FORESEE eMMC chip, which comes pre-flashed with some Android build
* One microSD card slot
* Two SATA 3.0 ports (standard Molex power connector is not populated)

=== 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.

=== 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 reported working (on the matrix channel) with latest neggles kernel.

== Boot ==

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

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

== Recovery ==

In the case you erase the eMMC and are unable to boot the board, you can use rkdeveloptool to recover the board. While you can use the [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool Pine64 Fork], it is recommended to use [https://gitlab.com/cypheon/rkdeveloptool/-/tree/main?ref_type=heads cypheon's Fork] until some Pending PRs are merged in to [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool/-/merge_requests?scope=all&state=opened&author_username=cypheon resolve issues] with larger files. This is important when working with the larger 64GB eMMC on the QuartzPro64.

With rkdeveloptool installed, you will also need the rk3588_spl from rockchip to init the memory/flash when in maskrom mode. This can be downloaded from the [https://github.com/rockchip-linux/rkbin/blob/master/bin/rk35/rk3588_spl_v1.12.bin rockchip-linux/rkbin repo].

Entering maskrom can be done in a variety of ways:

* Hold the maskrom button (little white button labelled "MASKROM" next to SATA socket) during powerup, OR
* Enter rockusb mode, and execute "rkdeveloptool reboot-maskrom".
* Bork your eMMC and SD devices (how? erase?), in which case bootup will fallback to maskrom.

=== Dumping the eMMC ===

Boot the device into maskrom mode, and then verify rkdeveloptool can see the board.
'''# rkdeveloptool list'''
DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=503 Maskrom

Once the board shows up, load the rk3588_spl you downloaded earlier, and verify that the eMMC can be seen.
'''# rkdeveloptool boot ./rk3588_spl_loader_v1.08.111.bin'''
Downloading bootloader succeeded.
'''# rkdeveloptool read-flash-info'''
Flash Info:
Manufacturer: SAMSUNG, value=00
Flash Size: 59000 MB
Flash Size: 120832000 Sectors
Block Size: 512 KB
Page Size: 2 KB
ECC Bits: 0
Access Time: 40
Flash CS: Flash<0>

You can now dump the eMMC using the read command. Note that first you have to calculate the eMMC size, which can be done using the output from the previous flash info command. You need to take the sector count, and times it by the sector size, to get the total number of bytes. So in the above example, 120832000*512 so the total flash size is 61865984000.

Using the calculated size, you can now dump the eMMC. Please note this will take 1-2 minutes.
'''# rkdeveloptool read 0x0 61865984000 ./quartzpro64_emmc_dump.bin'''
Read LBA to file (0%)
...
Read LBA to file (100%)

You now have a full dump of the entire eMMC (SHA256 62cb4ae8d02aeacccf231fa1d00087cdc74b599790a274569305693aa205318d). Note that you can also use the list-partitions and read-partition commands to dump specific partitions, but this only shows GPT partitions on the eMMC. Because of this, it will NOT include the spl_loader found in the first 4MB of the eMMC!

=== Flasing the eMMC ===

Boot the device into maskrom mode, and then verify rkdeveloptool can see the board.
'''# rkdeveloptool list'''
DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=503 Maskrom

Once the board shows up, load the rk3588_spl you downloaded earlier, and verify that the eMMC can be seen.
'''# rkdeveloptool boot ./rk3588_spl_loader_v1.08.111.bin'''
Downloading bootloader succeeded.
'''# rkdeveloptool read-flash-info'''
Flash Info:
Manufacturer: SAMSUNG, value=00
Flash Size: 59000 MB
Flash Size: 120832000 Sectors
Block Size: 512 KB
Page Size: 2 KB
ECC Bits: 0
Access Time: 40
Flash CS: Flash<0>

You can now flash the device using either the write command, or write-partition command, depending on what you are trying to do. If you are looking to restore the entire eMMC from a backup you made, you would use the command below to accomplish this.
'''rkdeveloptool write 0 ./quartzpro64_emmc_dump.bin'''

== Immediate TODOs ==

=== Enable cpufreq Stuff ===

Current neggles kernel has the CPU at 1.2 GHz, apparently SRE has patches to enable cpufreq? (see below, in [[QuartzPro64_Development#Kernel|Resources]])

=== 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!'''

To enter rockusb mode, interrupt the boot by holding the "V+/REC" on-board button or mashing Ctrl+C very quickly on the serial comms, then type <code>download</code>.

$ 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.

== 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 neggles / 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 (SRE) rk3588 branch]
* [https://github.com/rockchip-linux/kernel Rockchip BSP kernel tree]
* [https://gitlab.collabora.com/hardware-enablement/rockchip-3588/linux Collabora RK3588 integration branch]
* [https://gitlab.collabora.com/hardware-enablement/rockchip-3588/notes-for-rockchip-3588/-/blob/main/mainline-status.md Collabora Mainline Status Table]
* [https://github.com/radxa/kernel/tree/stable-5.10-rock5 Radxa kernel tree, for reference, a lot is happening here]

=== 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]
* [https://opensource.rock-chips.com/wiki_Main_Page Rockchip OpenSource wiki]
* [https://github.com/collabora/rockchiprs rockchiprs] (rkdeveloptool replacement written in Rust)

=== Documentation ===

The documentation for the QuartzPro64 board and most of the documentation for the chips it uses hasn't been publicly released yet, but if you do own a QuartzPro64 board, [[User:CounterPillow|CounterPillow]] or [[User:Dsimic|dsimic]] will happily provide the documentation to you for the research or development purposes, if you ask them in the PINE64 [[Main Page#Chat Platforms|chat channels]]. We've got the following documents, some of which can also be found elsewhere on the Internet rather easily:

* RK3588 datasheet
* RK3588 technical reference manual (TRM), parts 1 and 2
* RK3588 hardware design guide, machine translated to English from Chinese, and the original version in Chinese
* RK860 datasheet, including register descriptions
* RK806 datasheet, including register descriptions
* [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]
* [https://datasheet.lcsc.com/lcsc/2203311530_AMPAK-Tech-AP6275PR3_C2984106.pdf AMPAK AP6275PR3 (WiFi + BT module) datasheet]
* AMPAK AP6275P (WiFi + BT module) datasheet

[[Category:Rockchip RK3588]]
[[Category:QuartzPro64]]

Quartz64

2023-11-13T20:43:08Z

CameronNemo: remove weird space thingy

[[File:Quartz64modelb.png|400px|thumb|right|The Quartz64 Model B]]

The '''Quartz64''' is the most recent Single Board Computer offering from PINE64, with Model A initially released in June of 2021 and Model B in May of 2022. 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 slot (model B) using a single Gen2 lane electrically, and the use of LPDDR4 RAM.

The Quartz64 is available in two LPDDR4 system memory options: 4GB and 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 releases ==

Under [[Quartz64 Software Releases]] you will find a complete list of currently supported operating system images, which work with the Quartz64, as well as other related software.

== Getting started ==

=== Flashing the device ===

Natively the board only supports booting the platform firmware from SPI, the eMMC or a microSD card, see [[#Boot order|boot order]]. The platform firmware loaded from there (U-Boot, EDK2, ...) may then allow loading kernels from additional storage mediums or even the network, and they will have their own boot order.

The board can be booted by flashing your chosen operating system to a microSD card using another device and inserting the microSD card into the Quartz64, see the article [[Getting started]]. Flashing the eMMC is possible by booting an operating system from the microSD card and overwriting the eMMC from within the booted operating system, or by using [https://pine64.com/product/usb-adapter-for-emmc-module/ the USB eMMC adapter].

=== Boot order ===

The hardware boot order of the Quartz64 is:

# SPI NOR flash
# SPI NAND flash
# eMMC
# microSD card

== SoC and Memory Specifications ==

[[File:RK3566_icon.png|right]]

* Based on [https://www.rock-chips.com/a/en/products/RK35_Series/2021/0113/1274.html Rockchip RK3566]

=== 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
* [https://www.cnx-software.com/2020/12/01/rockchip-rk3568-processor-to-power-edge-computing-and-nvr-applications 22nm process, believed to be FD-SOI]

=== 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: 2GB (SOQuartz only), 4GB, 8GB LPDDR4.

=== Network ===

* 10/100/1000Mbps Ethernet
** Easily sustains >910 Mbit/s in a <code>--bidir</code> (i.e. sending and receiving at the same time) iperf3 TCP test.
* Wi-Fi 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) (removed in newer revisions due to electrical signalling issues it caused)
* optional eMMC module from 8GB up to 128GB
* 64 Mbit (8 MByte) SPI flash (Model B only), part number '''25Q64DWZPIG''' in the schematic

==== eMMC Speeds ====

On a 64 GB eMMC module:

$ sudo hdparm -tT /dev/mmcblk1

/dev/mmcblk1:
Timing cached reads: 2368 MB in 2.00 seconds = 1184.46 MB/sec
Timing buffered disk reads: 452 MB in 3.01 seconds = 149.98 MB/sec

=== 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
* Wi-Fi/BT Module Header - SDIO 3.0 and UART on model A, built-in Wi-Fi/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
** On Model A, the slot provides 10W of power for the 3.3V supply and however much power your 12V input power supply provides on the 12V supply

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).

==== Combo PHYs ====

[[File:rk3566 phy.png|400px]]

Several of the I/O options on the RK3566 used in the Quartz64 are using the same I/O lines, 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 no.
! scope="col" | Pin no.
! 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 [[File:Quartz64_model-A_schematic_v1.0_20201215.pdf|the board schematics]].

=== GPIO Pins (Quartz64 Model B) ===

Attention! GPIOs are 3.3V!

Interesting alternate pin configurations are listed in [brackets].

{| class="wikitable plainrowheaders" border="1"
! scope="col" style="width:20em;" | Assigned To
! scope="col" | Pin no.
! scope="col" | Pin no.
! scope="col" style="width:20em;" | Assigned To
|-
| style="text-align:right;"| 3.3 V
| style="text-align:center; background-color:yellow; color:black; font-weight:bold;"| 1
| style="text-align:center; background-color:red; color:gold; font-weight:bold;"| 2
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| ''[I2C3_SDA_M0]'' GPIO1_A0_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 3
| style="text-align:center; background-color:red; color:gold; font-weight:bold;"| 4
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| ''[I2C3_SCL_M0]'' GPIO1_A1_3V3
| style="text-align:center; background-color:green; 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;"| GPIO3_C4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 7
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 8
| style="text-align:left;"| UART2_TX
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 9
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 10
| style="text-align:left;"| UART2_RX
|-
| style="text-align:right;"| ''[SPI1_CS0_M1]'' GPIO3_A1_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 11
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 12
| style="text-align:left;"| GPIO3_A3_3V3 ''[I2S3_SCLK_M0]''
|-
| style="text-align:right;"| ''[I2S3_MCLK_M0]'' GPIO3_A2_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 13
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 14
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_B0_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 15
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 16
| style="text-align:left;"| GPIO3_B1_3V3
|-
| style="text-align:right;"| 3.3V
| style="text-align:center; background-color:yellow; color:black; font-weight:bold;"| 17
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 18
| style="text-align:left;"| GPIO3_B2_3V3
|-
| style="text-align:right;"| GPIO4_C3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 19
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 20
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO4_C5_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 21
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 22
| style="text-align:left;"| GPIO3_C1_3V3 ''[SPI1_MOSI_M1]''
|-
| style="text-align:right;"| GPIO4_C2_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 23
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 24
| style="text-align:left;"| GPIO4_C6_3V3
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 25
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 26
| style="text-align:left;"| GPIO4_D1_3V3
|-
| style="text-align:right;"| I2C4_SDA_M0
| style="text-align:center; background-color:blue; color:gold; font-weight:bold;"| 27
| style="text-align:center; background-color:blue; color:gold; font-weight:bold;"| 28
| style="text-align:left;"| I2C4_SCL_M0
|-
| style="text-align:right;"| GPIO3_B3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 29
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 30
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_B4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 31
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 32
| style="text-align:left;"| GPIO3_C2_3V3 ''[SPI1_MISO_M1]''
|-
| style="text-align:right;"| ''[SPI1_CLK_M1]'' GPIO3_C3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 33
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 34
| style="text-align:left;"| GND
|-
| style="text-align:right;"| ''[I2S3_LRCK_M0]'' GPIO3_A4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 35
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 36
| style="text-align:left;"| GPIO3_A7_3V3
|-
| style="text-align:right;"| ''[SPDIF_TX_M0]'' GPIO1_A4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 37
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 38
| style="text-align:left;"| GPIO3_A6_3V3 ''[I2S3_SDI_M0]''
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 39
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 40
| style="text-align:left;"| GPIO3_A5_3V3 ''[I2S3_SDO_M0]''
|}

Source: Page 24 of [https://files.pine64.org/doc/quartz64/Quartz64_model-B_Schematic-V1.3_20220124.pdf the board schematics].

== Quartz64 Board Information, Schematics, and Certifications ==

=== Model "A" ===

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]

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 CE Certificate]
* [https://files.pine64.org/doc/cert/Quartz64%20Model-A%20FCC%20certification-S21051101702001.pdf Quartz64 model-A FCC Certificate]

=== Model "B" ===

Model "B" Baseboard Dimensions: 85mm x 56mm x 18.8mm

Input Power: DC 5V @ 3A 3.5mmOD/1.35mmID center-positive Barrel DC Jack connector

Quartz64 Model "B" SBC Schematic and PCB Board Resource:

* [https://files.pine64.org/doc/quartz64/Quartz64_model-B_Schematic-V1.3_20220124.pdf Quartz64 Model "B" SBC Schematic ver 1.3 20220124 PDF file]
* [https://files.pine64.org/doc/quartz64/Quartz64_model-B_PCB_Components_Placement-V1.2_20211014.pdf Quartz64 Model "B" SBC PCB Connector placement PDF file]
* Please note that v1.2 and V1.3 schematic and component placement are identical, just some component value changed.
* Note: Model B uses a Molex PicoBlade compatible connector for the RTC battery. The Pine64 Backup Battery Holders come with a JST PH type connector. To use the Pine64 RTC Backup Battery Holder, the connector on the battery holder will need to be modified with a PicoBlade type connector.

== 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]
* [https://opensource.rock-chips.com/images/2/26/Rockchip_RK3568_TRM_Part1_V1.3-20220930P.PDF Rockchip RK3566 and RK3568 TRM (Technical Reference Manual)]

Rockchip PMU (Power Management Unit) Information:
* [https://www.rockchip.fr/RK817%20datasheet%20V1.01.pdf Rockchip RK817 ver 1.01 datasheet for Quartz64 model A]
* [https://www.rockchip.fr/RK809%20datasheet%20V1.01.pdf Rockchip RK809 ver 1.01 datasheet for Quartz64 model B and SOQuartz]

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]
* [https://files.pine64.org/doc/datasheet/PineNote/TI%20PMU-TPS651851.pdf TPS65185x PMIC for E-Ink Enabled Electronic Paper Display Datasheet]

LCD Touch Screen Panel information:
* [https://files.pine64.org/doc/datasheet/pine64/FY07024DI26A30-D_feiyang_LCD_panel.pdf 7.0" 1024x600 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]

Wi-Fi/BT module info:
* [https://files.pine64.org/doc/datasheet/rockpro64/AW-CM256SM_DS_DF_V1.9_STD.pdf Azurewave CM256SM 11AC Wi-Fi + Bluetooth5.0 Datasheet]

IR LED:
* [https://media.digikey.com/pdf/Data%20Sheets/Everlight%20PDFs/IRM-36xx_Series.pdf IRM-3638 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]
* [https://www.printables.com/model/269572-pine-quartz-64-a-full-case 3D Printable Enclosure for Model A]
* [https://www.printables.com/model/269575-pine-quartz-64-a-open-frame Open Frame for Model A]

Connector information:
* [https://files.pine64.org/doc/datasheet/pine64/ePH.pdf 2.0mm PH Type connector specification use in Lithium Battery (VBAT) port (Model A)]
* [https://www.molex.com/pdm_docs/sd/533980271_sd.pdf 1.25mm Picoblade Type connector specification used in RTC Battery port (Model B)]
* [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]

== Enclosures ==

Note: Please expand this section with more cases known to work.

=== Model "A" ===

All enclosures that fit the ROCKPro64 should fit the Quartz64 Model "A", as the I/O has been laid out the same on purpose.

* [[Model A Acrylic Open Enclosure]] - but see the troubleshooting section below.
* [[Quartz64 Premium Aluminium Case|RockPro64 Premium Aluminium Case]]
* [[ROCKPro64#3D printable ITX mounting brackets]] (Not an enclosure but allows to mount the board in an ATX/ITX case)

=== Model "B" ===

* [[Model B Acrylic Open Enclosure]]
* the ROCK64 aluminium enclosure '''does not''' work, as the DC input jack is placed differently

== 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. '''This affects model A only'''

=== 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, because if the generic PHY driver is built in it will bind to the PHY first, unless you include the motorcomm module in your initramfs.

Note: Starting with [https://salsa.debian.org/kernel-team/linux/-/merge_requests/551 Debian's <code>6.1~rc3-1~exp1</code> kernel] the module is included, but set to <code>m</code> and I (Diederik) have verified that it gets included in the initramfs and '''works''' on Model-A and Model-B with the [[Quartz64#Plebian]] images.

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

The Quartz64 does not really fit onto the bottom plate of the [[Model A Acrylic Open Enclosure]]. 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 millimeters.

[[File:Quartz64-audio-jack-spacer-issue.jpg|400px]]

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.

=== No GPU Acceleration with Debian "Bullseye" Userland ===

Debian Bullseye ships a Mesa version that is too old to contain the required patches for the RK356x SoC's GPU. Upgrade to Bookworm.

=== Wireless Connectivity Doesn't Work ===

ROCKPro64 wireless module may have CYW43455 or CYW43456 chips on board (not sure if this is the same for Quartz64 model B). Both chips are supported by <code>brcmfmac</code> Wi-Fi driver and <code>btbcm</code> Bluetooth driver.

For CYW43455 drivers attempt to load <code>/lib/firmware/brcm/brcmfmac43455-sdio.bin</code> for Wi-Fi and <code>/lib/firmware/brcm/BCM4345C0.hcd</code> for Bluetooth. Corresponding firmware files for CYW43456 are <code>/lib/firmware/brcm/brcmfmac43456-sdio.bin</code> and <code>/lib/firmware/brcm/BCM4345C5.hcd</code>.

On Manjaro firmware files for both Bluetooth and Wi-Fi on CYW43456 on are provided by <code>ap6256-firmware</code> package (<code>pacman -S ap6256-firmware</code>).

However for CYW43455 wi-fi firmware is in the <code>linux-firmware</code> package and bluetooth is in the <code>firmware-raspberrypi</code> (<code>pacman -S linux-firmware firmware-raspberrypi</code>). <code>linux-firmware</code> package is missing device specific symlinks for quartz64-a. To create them execute:

# ln -s brcmfmac43455-sdio.bin /lib/firmware/brcm/brcmfmac43455-sdio.pine64,quartz64-a.bin
# ln -s brcmfmac43455-sdio.AW-CM256SM.txt /lib/firmware/brcm/brcmfmac43455-sdio.pine64,quartz64-a.txt

As of 2022-10-19 device tree in mainline kernel for Quartz64 model A has wrong configuration for the Bluetooth driver. [https://patchwork.kernel.org/project/linux-rockchip/patch/20220926125350.64783-1-leo@nabam.net/ Patch] is submitted to the LKML and accepted and included upstream in 6.1-rc7. It's possible to modify dtb file provided by the current kernel using device tree compiler to enable Bluetooth or perform <code>make dtbs</code> in the patched kernel tree to get updated dtb file (<code>arch/arm64/boot/dts/rockchip/rk3566-quartz64-a.dtb</code>). Issue manifests itself with following errors in `dmesg`:

command 0x0c03 tx timeout
Bluetooth: hci0: BCM: Reset failed (-110)

== How-To ==

=== Connect Debug UART ===

The easiest way to get debug output is to connect a 3.3V 1.5mbaud capable UART adapter to the board.

To connect it, connect the ground lead to pin 6, and the RX/TX leads to pins 8 and 10 (consider swapping them if you get no output, things are often mislabeled). These pins are "UART2" in the above GPIO table.

Open a serial terminal at 1500000 bauds, e.g.

$ picocom -b 1500000 /dev/ttyUSB0

=== Disable Heartbeat LED (Linux) ===

The flashing LED is called the "heartbeat LED", it blinks in a heart rhythm like fashion once the kernel is running. To disable it, you can run

# echo none > /sys/class/leds/user-led/trigger

On model A LED device is called "diy-led", not "user-led".

On a system with systemd, you can do this as soon as the system is ready to be logged in with a systemd unit like this:

[Unit]
Description=Turn off heartbeat LED
Wants=multi-user.target
After=multi-user.target

[Install]
WantedBy=multi-user.target

[Service]
Type=simple
ExecStart=sh -c 'echo none > /sys/class/leds/user-led/trigger'

Place it in ''/etc/systemd/system/user-led.service'', and run

# systemctl daemon-reload
# systemctl enable user-led.service

Upon rebooting, you will now notice that the heartbeat LED will blink during boot-up, but stops blinking as soon as the multi-user target is reached (i.e. the user can log in).

=== SATA on model A ===

On model A USB 3.0 and SATA ports are using the same I/O line and can't be used simultaneously. By default USB 3.0 is enabled in Linux device tree and SATA is disabled. FDT modifications are required to turn SATA on.

Following script is tested on Manjaro but should work on the other distributions with minimal changes. Device tree compiler package usually provides fdtput command (on Manjaro run: <code>pacman -S dtc</code>)

# cp /boot/dtbs/rockchip/rk3566-quartz64-a.dtb /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb
# fdtput -t s -v /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb /usb@fd000000 status disabled
# fdtput -t s -v /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb /sata@fc400000 status okay
# sed -i 's#^FDT /dtbs/rockchip/rk3566-quartz64-a.dtb$#FDT /dtbs/rockchip/rk3566-quartz64-a-sata.dtb#' /boot/extlinux/extlinux.conf
# systemctl reboot

=== Using a PCF8574 on Model A ===

See [[Quartz64 Model A using a PCF8574]].

=== Using a battery on Model A ===

See [[Quartz64 Model A Using a battery]].

=== Connecting a MIPI-DSI display ===

See [[Quartz64 connecting a MIPI-DSI display]].

=== Building Mainline U-Boot ===

See [[Quartz64 Building U-Boot]].

== Frequently Asked Questions ==

=== Do I Need A Fan/What Heatsink Do I Need? ===

You don't need a fan. The [https://pine64.com/product/rockpro64-20mm-mid-profile-heatsink/ 20mm medium heatsink for Model A is plenty enough]. For Model B, the [https://pine64.com/product/small-fan-type-heatsink/ fan type heatsink] will do fine.

=== Can This Run A Minecraft Server? ===

Yes! Sort of. Testing on an 8GB Model A with PaperMC, [[User:CounterPillow]] was able to out-row world generation in a boat with just one player online, but aside from the slow world gen (which can be pre-generated) the server handled things like TNT explosions and mobs fine. It'll probably do okay with 1-3 players.

=== Do I Need The 5A Power Supply For Model A? ===

You only need the 5A power supply for Model A if you plan on connecting hard disk drives to the 12V header on the board.

=== How Much Power Does It Consume? ===

For Model B, it's <2W in idle (powertop tunables not set), and <5W under full CPU load (<code>stress-ng -c4</code>). Model A will be similar as it's the same SoC.

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

Quartz64 Development

2023-08-14T04:38:54Z

CameronNemo: /* Upstreaming 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/linus/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:PaleGreen; text-align:center;"|Linux Mainline
| <code>dw-mipi-dsi-rockchip</code>
| As of 6.1[https://git.kernel.org/linus/e18d9b093006d8abd53e1ce13c0d5a8d0fcd5f64]
|
|-
! 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/linus/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 MPEG-2, VP8 and H.264. Mainline as of 5.19[https://git.kernel.org/linus/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:PaleGreen; text-align:center;"|Linux Mainline
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based. Mainline as of 6.1[https://git.kernel.org/linus/6f1ae821a6c4aa9d5b8f437b27ec86fb569219fd]
|
|-
| 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/linus/43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/linus/dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/linus/0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" rowspan="3" | Bootloader
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952]
| <code>TF-A</code>
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|Merged
| <code>U-Boot</code>
| [[#Mainline_U-Boot_Work|See below]]. Quartz64 and SOQuartz as of v2023.10-rc2[https://source.denx.de/u-boot/u-boot/-/commit/4e619e8d4fd68095bc665a78f2651d8e478a4534]
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress[https://github.com/jaredmcneill/quartz64_uefi]
| <code>Tianocore EDK II</code>
|
|-
! 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/linus/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/linus/c37415f55bdadffe5b4c0e7981e9fc7e8b96beea]
| Quartz64 Model B
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| SOQuartz
| As of 5.19[https://git.kernel.org/linus/c466828fb3ba8cb7f5c3bf28766da9b70bf9745e]
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/linus/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/linus/3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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 writing
| <code>gp7101</code>
| Someone should write a pwm driver for it so we can then use pwm-fan
| 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 Mainline
| <code>rockchip-inno-csidphy</code>
| As of 6.1[https://git.kernel.org/linus/29c99fb085ad53e6d5504d1f8d32e6673b9b3a2c]
|
|-
! scope="row" | NPU
| colspan="2" style="background:#F99; text-align:center;"|Needs writing
|
| Downstream version is a closed source SDK and [https://github.com/dieselnutjob/kernel-rk3566/tree/linux-4.19.210/drivers/rknpu open source kernel module rknpu]. 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.
|
|-
! scope="row" | TRNG
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=699813]
| <code>rockchip-rng</code>
|
|
|-
! scope="row" rowspan="2" | Wi-Fi
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>bes2600</code>
| A downstream driver is available but it makes use of some custom Rockchip interfaces and is designed for older kernels, plans are being made to port it to DKMS.
| PineTab 2
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
| Quartz64 Model B
|}

== 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
** H.264
* Video Encode
** JPEG (it's pretty bad)
* 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 (applies to Model A only) — 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.
* RGA — only works with memory ≤ 4 GiB, because Rockchip didn't make the address registers larger. Oopsie.

=== 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.

I (liamur) [https://github.com/liamhays/rk3566-mcu did some investigation] into the MCU and found that it is disabled by TF-A on suspend, and doesn't reside in a low-power part of the RK3566 anyway. It does however have access to most of the chip and could be used as (for example) a real-time coprocessor.

=== Mainline U-Boot Work ===

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, even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Mainline U-Boot contains good enough support for the RK3566 SoC used on the Quartz64 as of v2023.07 and have support for Quartz64 and SOQuartz as of v2023.10-rc2. Drivers for [https://patchwork.ozlabs.org/cover/1817577/ ethernet GMAC] and [https://patchwork.ozlabs.org/patch/1817295/ Motorcomm PHY] have been submitted for review.

==== Things that could be done ====

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

* 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 PHY for Model A, 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_REALTEK_PHY</code>
** Ethernet PHY for Model B
* <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
* <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
* <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
* <code>CONFIG_I2C_RK3X</code>
** I2C 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
* eMMC
* SD-Card

... 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

2023-07-14T17:49:37Z

CameronNemo: /* Linux Kernel Config Options */ dsi and charger were merged, and do not need patches

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/linus/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:PaleGreen; text-align:center;"|Linux Mainline
| <code>dw-mipi-dsi-rockchip</code>
| As of 6.1[https://git.kernel.org/linus/e18d9b093006d8abd53e1ce13c0d5a8d0fcd5f64]
|
|-
! 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/linus/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 MPEG-2, VP8 and H.264. Mainline as of 5.19[https://git.kernel.org/linus/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:PaleGreen; text-align:center;"|Linux Mainline
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based. Mainline as of 6.1[https://git.kernel.org/linus/6f1ae821a6c4aa9d5b8f437b27ec86fb569219fd]
|
|-
| 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/linus/43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/linus/dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/linus/0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" rowspan="3" | Bootloader
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952]
| <code>TF-A</code>
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress
| <code>U-Boot</code>
| [[Quartz64_Development#Mainline_U-Boot_Work|See below]]
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress[https://github.com/jaredmcneill/quartz64_uefi]
| <code>Tianocore EDK II</code>
|
|-
! 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/linus/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/linus/c37415f55bdadffe5b4c0e7981e9fc7e8b96beea]
| Quartz64 Model B
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| SOQuartz
| As of 5.19[https://git.kernel.org/linus/c466828fb3ba8cb7f5c3bf28766da9b70bf9745e]
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/linus/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/linus/3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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/linus/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 writing
| <code>gp7101</code>
| Someone should write a pwm driver for it so we can then use pwm-fan
| 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 Mainline
| <code>rockchip-inno-csidphy</code>
| As of 6.1[https://git.kernel.org/linus/29c99fb085ad53e6d5504d1f8d32e6673b9b3a2c]
|
|-
! 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.
|
|-
! scope="row" | TRNG
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=699813]
| <code>rockchip-rng</code>
|
|
|-
! scope="row" rowspan="2" | Wi-Fi
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>bes2600</code>
| A downstream driver is available but it makes use of some custom Rockchip interfaces and is designed for older kernels, plans are being made to port it to DKMS.
| PineTab 2
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
| Quartz64 Model B
|}

== 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
** H.264
* Video Encode
** JPEG (it's pretty bad)
* 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 (applies to Model A only) — 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.
* RGA — only works with memory ≤ 4 GiB, because Rockchip didn't make the address registers larger. Oopsie.

=== 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 ===

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, even with Rockchip blobs, a more modern version of U-Boot will be much nicer to use.

Mainline U-Boot contains good enough support for the RK3566 SoC used on the Quartz64 as of v2023.07, patches are still in review for e.g. PCIe/NVMe/AHCI support.

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

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

* Bring the kernel's Quartz64 DTSes into the tree (CounterPillow did this [https://github.com/CounterPillow/u-boot-quartz64/commits/mainline-ish-2 in his tree], Kwiboo refined this [https://github.com/Kwiboo/u-boot-rockchip/commits/rk3568-2023.07 in his tree])
* Write <code>defconfig</code>s based on <code>evb-rk3568_defconfig</code> (CounterPillow did this [https://github.com/CounterPillow/u-boot-quartz64/commits/mainline-ish-2 in his tree], Kwiboo refined this [https://github.com/Kwiboo/u-boot-rockchip/commits/rk3568-2023.07 in his tree])

Stretch Goals:

* Port the Motorcomm PHY driver to u-boot for networking
** Only needed for Model A, RTL8211 on Model B is already supported in mainline u-boot
* 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 PHY for Model A, 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_REALTEK_PHY</code>
** Ethernet PHY for Model B
* <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
* <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
* <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
* <code>CONFIG_I2C_RK3X</code>
** I2C 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
* eMMC
* SD-Card

... 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-12-29T07:07:41Z

CameronNemo: Correct kernel version merged

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:PaleGreen; text-align:center;"|Linux Mainline
| <code>dw-mipi-dsi-rockchip</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=e18d9b093006d8abd53e1ce13c0d5a8d0fcd5f64]
|
|-
! 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:PaleGreen; text-align:center;"|Linux Mainline
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based. Mainline as of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=6f1ae821a6c4aa9d5b8f437b27ec86fb569219fd]
|
|-
| 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" rowspan="3" | Bootloader
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952]
| <code>TF-A</code>
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress
| <code>U-Boot</code>
| [[Quartz64_Development#Mainline_U-Boot_Work|See below]]
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress[https://github.com/jaredmcneill/quartz64_uefi]
| <code>Tianocore EDK II</code>
|
|-
! 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 Mainline
| <code>rockchip-inno-csidphy</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=29c99fb085ad53e6d5504d1f8d32e6673b9b3a2c]
|
|-
! 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.
|
|-
! scope="row" | TRNG
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=694733&archive=both]
| <code>rockchip-rng</code>
|
|
|}

== 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
** H.264
* Video Encode
** JPEG (it's pretty bad)
* 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 (applies to Model A only) — 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.
* RGA — only works with memory ≤ 4 GiB, because Rockchip didn't make the address registers larger. Oopsie.

=== 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.

=== OS Images ===

We need a '''Debian-based''' OS image with a packaged '''mainline kernel''' that's updated through a repository for SOQuartz and Quartz64 Model B. Other distribution userlands are welcome as well, but a lot of users are looking for Debian or Ubuntu. Do keep in mind that it'll probably have to be Bookworm due to the mesa GPU support stuff.

== 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]]

Quartz64 Development

2022-12-29T07:03:47Z

CameronNemo: DSI was merged

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:PaleGreen; text-align:center;"|Linux Mainline
| <code>dw-mipi-dsi-rockchip</code>
| As of 6.2[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=e18d9b093006d8abd53e1ce13c0d5a8d0fcd5f64]
|
|-
! 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:PaleGreen; text-align:center;"|Linux Mainline
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based. Mainline as of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=6f1ae821a6c4aa9d5b8f437b27ec86fb569219fd]
|
|-
| 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" rowspan="3" | Bootloader
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952]
| <code>TF-A</code>
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress
| <code>U-Boot</code>
| [[Quartz64_Development#Mainline_U-Boot_Work|See below]]
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress[https://github.com/jaredmcneill/quartz64_uefi]
| <code>Tianocore EDK II</code>
|
|-
! 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 Mainline
| <code>rockchip-inno-csidphy</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=29c99fb085ad53e6d5504d1f8d32e6673b9b3a2c]
|
|-
! 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.
|
|-
! scope="row" | TRNG
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=694733&archive=both]
| <code>rockchip-rng</code>
|
|
|}

== 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
** H.264
* Video Encode
** JPEG (it's pretty bad)
* 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 (applies to Model A only) — 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.
* RGA — only works with memory ≤ 4 GiB, because Rockchip didn't make the address registers larger. Oopsie.

=== 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.

=== OS Images ===

We need a '''Debian-based''' OS image with a packaged '''mainline kernel''' that's updated through a repository for SOQuartz and Quartz64 Model B. Other distribution userlands are welcome as well, but a lot of users are looking for Debian or Ubuntu. Do keep in mind that it'll probably have to be Bookworm due to the mesa GPU support stuff.

== 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]]

User talk:Vincele

2022-11-21T20:01:22Z

CameronNemo: Add PBP void section

===Void Linux PBP===

Hey, I know installing Void Linux on the PBP is not quite straightforward or documented. Thanks for trying to help with that. I am a little concerned about recommending users manage their own kernels, however. Just want to steer users toward the more automated and supportable options out there. Hopefully you feel that is valuable. Thanks, and well wishes!

Pinebook Pro Installing Void Linux ARM

2022-11-21T19:59:32Z

CameronNemo: Make sure to steer people toward the official solutions, or at least mention their existence.

{{Warning|This guide is a Work In Progress; no warranty is implied.
This installation method is not officially recommended (or discouraged) by the Void Linux project.
This guide is for experienced Linux users.}}

This will not be a complete guide, as it borrows heavily on [[Installing Arch Linux ARM On The Pinebook Pro]], so read it first then come back here.

Only the steps that are different are listed here. Be careful, the numbering of the sections is not the same.

==Installing the root filesystem==

=== Downloading and verifying the rootfs tarball ===

You can go to the Void linux [https://voidlinux.org/download/ download page], select the "arm" tab, and choose one of the aarch64 rootfs tarballs, either glibc or musl.
How to check integrity of the downloaded file is explained on the same page.

Or use the following instructions (on debian):
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/void-aarch64-musl-ROOTFS-20221001.tar.xz</nowiki>
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/sha256sum.{txt,sig}</nowiki>
<nowiki>$ wget https://github.com/void-linux/void-packages/raw/master/srcpkgs/void-release-keys/files/void-release-20221001.pub</nowiki>
$ signify-openbsd -V -p void-release-20221001.pub -x sha256sum.sig -m sha256sum.txt
Signature Verified
$ sha256sum -c --ignore-missing sha256sum.txt
void-aarch64-musl-ROOTFS-20221001.tar.xz: OK

=== Extracting and configuring the root filesystem ===
==== Extracting the root filesystem ====
# tar -xpf void-aarch64-musl-ROOTFS-20221001.tar.xz -C /mnt

==== Kernel ====

The Void linux rootfs tarball does not contain a kernel, however the '''pinebookpro-kernel''' package can be installed from the Void Linux repos. Alternatively, one can (cross) build a kernel themselves. Skip this section if you would rather install the package.

===== Cross-compiling a mainline kernel suitable for the Pinebook Pro =====
We'll use the PostmarketOS kernel configuration and boot parameters, because they are working properly, and are sufficiently up-to-date. This is done from an x86_64 computer.

This has been tested with PMOS configuration for 6.0.2 and kernel 6.1.0-rc5+. No initramfs was needed to boot the OS.

$ git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$ cd linux
$ wget -O .config https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/linux-postmarketos-rockchip/config-postmarketos-rockchip.aarch64
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 oldconfig
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j$(grep -c '^processor' /proc/cpuinfo)

===== Installing the newly built kernel, modules & DTB files =====

$ KVER="$(make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 kernelrelease)"
$ sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 modules_install dtbs_install \
INSTALL_MOD_STRIP=1 \
INSTALL_MOD_PATH=/mnt \
INSTALL_DTBS_PATH=/mnt/boot/dtbs
$ sudo cp arch/arm64/boot/Image "/mnt/boot/Image-${KVER}"

==== Configuring a login agent on the serial console ====
# cp -R /mnt/etc/sv/agetty-ttyS0 /mnt/etc/sv/agetty-ttyS2
# ln -sf /etc/sv/agetty-ttyS2 /mnt/etc/runit/runsvdir/default

==== Creating extlinux.conf ====

Note: if using the official PBP kernel package, it is also recommended to use the '''u-boot-menu''' package, which automatically regenerates the extlinux.conf file on kernel upgrades. In that case, you will not need to follow the below instructions.

The following borrows from [https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/device-pine64-pinebookpro/extlinux.conf PostmarketOS u-boot configuration for the kernel command-line parameters].

We force the serial console to 115200 bauds (from the default 1.5M bauds), so that it is the same as tow-boot's.

# mkdir -p /mnt/boot/extlinux
# cat <<EOF > /mnt/boot/extlinux/extlinux.conf
default l0
menu title Pinebook Pro Boot Menu
prompt 0
timeout 50

label l0
menu label Boot Kernel on SD
linux /Image-${KVER}
fdt /dtbs/rockchip/rk3399-pinebook-pro.dtb
append console=tty0 console=ttyS2,115200n8 coherent_pool=1M pcie_aspm.policy=performance video=HDMI-A-1:1920x1080@60 video=eDP-1:1920x1080@60 rw rootwait root=/dev/mmcblk1p3
EOF

=== Finalizing ===

Now you can umount the partition(s) and boot the Pinebook Pro with Void Linux.

Pinebook Pro Installing Void Linux ARM

2022-11-21T19:16:03Z

CameronNemo: /* Kernel */

{{Warning|This guide is a Work In Progress; no warranty is implied.
This installation method is not officially recommended (or discouraged) by the Void Linux project.
This guide is for experienced Linux users.}}

This will not be a complete guide, as it borrows heavily on [[Installing Arch Linux ARM On The Pinebook Pro]], so read it first then come back here.

Only the steps that are different are listed here. Be careful, the numbering of the sections is not the same.

=== Downloading and verifying the rootfs tarball ===

You can go to the Void linux [https://voidlinux.org/download/ download page], select the "arm" tab, and choose one of the aarch64 rootfs tarballs, either glibc or musl.
How to check integrity of the downloaded file is explained on the same page.

Or use the following instructions (on debian):
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/void-aarch64-musl-ROOTFS-20221001.tar.xz</nowiki>
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/sha256sum.{txt,sig}</nowiki>
<nowiki>$ wget https://github.com/void-linux/void-packages/raw/master/srcpkgs/void-release-keys/files/void-release-20221001.pub</nowiki>
$ signify-openbsd -V -p void-release-20221001.pub -x sha256sum.sig -m sha256sum.txt
Signature Verified
$ sha256sum -c --ignore-missing sha256sum.txt
void-aarch64-musl-ROOTFS-20221001.tar.xz: OK

=== Extracting and configuring the root filesystem ===
==== Extracting the root filesystem ====
# tar -xpf void-aarch64-musl-ROOTFS-20221001.tar.xz -C /mnt

==== Configuring a login agent on the serial console ====
# cp -R /mnt/etc/sv/agetty-ttyS0 /mnt/etc/sv/agetty-ttyS2
# ln -sf /etc/sv/agetty-ttyS2 /mnt/etc/runit/runsvdir/default

=== Kernel ===
The Void linux rootfs tarball does not contain a kernel, however the '''pinebookpro-kernel''' package can be installed the Void Linux repos. Alternatively, one can (cross) build a kernel themselves.

=== Cross-compiling a mainline kernel suitable for the Pinebook Pro ===
We'll use the PostmarketOS kernel configuration and boot parameters, because they are working properly, and are sufficiently up-to-date. This is done from an x86_64 computer.

This has been tested with PMOS configuration for 6.0.2 and kernel 6.1.0-rc5+. No initramfs was needed to boot the OS.

$ git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$ cd linux
$ wget -O .config https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/linux-postmarketos-rockchip/config-postmarketos-rockchip.aarch64
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 oldconfig
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j$(grep -c '^processor' /proc/cpuinfo)

=== Installing the newly built kernel, modules & DTB files ===

$ KVER="$(make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 kernelrelease)"
$ sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 modules_install dtbs_install \
INSTALL_MOD_STRIP=1 \
INSTALL_MOD_PATH=/mnt \
INSTALL_DTBS_PATH=/mnt/boot/dtbs
$ sudo cp arch/arm64/boot/Image "/mnt/boot/Image-${KVER}"

=== Configuring tow-boot with extlinux.conf===
The following borrows from [https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/device-pine64-pinebookpro/extlinux.conf PostmarketOS u-boot configuration for the kernel command-line parameters].

We force the serial console to 115200 bauds (from the default 1.5M bauds), so that it is the same as tow-boot's.

# mkdir -p /mnt/boot/extlinux
# cat <<EOF > /mnt/boot/extlinux/extlinux.conf
default l0
menu title Pinebook Pro Boot Menu
prompt 0
timeout 50

label l0
menu label Boot Kernel on SD
linux /Image-${KVER}
fdt /dtbs/rockchip/rk3399-pinebook-pro.dtb
append console=tty0 console=ttyS2,115200n8 coherent_pool=1M pcie_aspm.policy=performance video=HDMI-A-1:1920x1080@60 video=eDP-1:1920x1080@60 rw rootwait root=/dev/mmcblk1p3
EOF

=== Finalizing ===
Now you can umount the partition(s) and boot the Pinebook Pro with Void Linux.

Pinebook Pro Installing Void Linux ARM

2022-11-21T19:15:40Z

CameronNemo: /* Kernel */ Note that there is already a Void Linux kernel package, so building your own kernel is optional

{{Warning|This guide is a Work In Progress; no warranty is implied.
This installation method is not officially recommended (or discouraged) by the Void Linux project.
This guide is for experienced Linux users.}}

This will not be a complete guide, as it borrows heavily on [[Installing Arch Linux ARM On The Pinebook Pro]], so read it first then come back here.

Only the steps that are different are listed here. Be careful, the numbering of the sections is not the same.

=== Downloading and verifying the rootfs tarball ===

You can go to the Void linux [https://voidlinux.org/download/ download page], select the "arm" tab, and choose one of the aarch64 rootfs tarballs, either glibc or musl.
How to check integrity of the downloaded file is explained on the same page.

Or use the following instructions (on debian):
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/void-aarch64-musl-ROOTFS-20221001.tar.xz</nowiki>
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/sha256sum.{txt,sig}</nowiki>
<nowiki>$ wget https://github.com/void-linux/void-packages/raw/master/srcpkgs/void-release-keys/files/void-release-20221001.pub</nowiki>
$ signify-openbsd -V -p void-release-20221001.pub -x sha256sum.sig -m sha256sum.txt
Signature Verified
$ sha256sum -c --ignore-missing sha256sum.txt
void-aarch64-musl-ROOTFS-20221001.tar.xz: OK

=== Extracting and configuring the root filesystem ===
==== Extracting the root filesystem ====
# tar -xpf void-aarch64-musl-ROOTFS-20221001.tar.xz -C /mnt

==== Configuring a login agent on the serial console ====
# cp -R /mnt/etc/sv/agetty-ttyS0 /mnt/etc/sv/agetty-ttyS2
# ln -sf /etc/sv/agetty-ttyS2 /mnt/etc/runit/runsvdir/default

=== Kernel ===
The Void linux rootfs tarball does not contain a kernel, however there is the '''pinebookpro-kernel''' package that can be installed the Void Linux repos. Alternatively, one can (cross) build a kernel themselves.

=== Cross-compiling a mainline kernel suitable for the Pinebook Pro ===
We'll use the PostmarketOS kernel configuration and boot parameters, because they are working properly, and are sufficiently up-to-date. This is done from an x86_64 computer.

This has been tested with PMOS configuration for 6.0.2 and kernel 6.1.0-rc5+. No initramfs was needed to boot the OS.

$ git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$ cd linux
$ wget -O .config https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/linux-postmarketos-rockchip/config-postmarketos-rockchip.aarch64
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 oldconfig
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j$(grep -c '^processor' /proc/cpuinfo)

=== Installing the newly built kernel, modules & DTB files ===

$ KVER="$(make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 kernelrelease)"
$ sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 modules_install dtbs_install \
INSTALL_MOD_STRIP=1 \
INSTALL_MOD_PATH=/mnt \
INSTALL_DTBS_PATH=/mnt/boot/dtbs
$ sudo cp arch/arm64/boot/Image "/mnt/boot/Image-${KVER}"

=== Configuring tow-boot with extlinux.conf===
The following borrows from [https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/device-pine64-pinebookpro/extlinux.conf PostmarketOS u-boot configuration for the kernel command-line parameters].

We force the serial console to 115200 bauds (from the default 1.5M bauds), so that it is the same as tow-boot's.

# mkdir -p /mnt/boot/extlinux
# cat <<EOF > /mnt/boot/extlinux/extlinux.conf
default l0
menu title Pinebook Pro Boot Menu
prompt 0
timeout 50

label l0
menu label Boot Kernel on SD
linux /Image-${KVER}
fdt /dtbs/rockchip/rk3399-pinebook-pro.dtb
append console=tty0 console=ttyS2,115200n8 coherent_pool=1M pcie_aspm.policy=performance video=HDMI-A-1:1920x1080@60 video=eDP-1:1920x1080@60 rw rootwait root=/dev/mmcblk1p3
EOF

=== Finalizing ===
Now you can umount the partition(s) and boot the Pinebook Pro with Void Linux.

Pinebook Pro Installing Void Linux ARM

2022-11-21T19:08:54Z

CameronNemo: Update warning

{{Warning|This guide is a Work In Progress; no warranty is implied.
This installation method is not officially recommended (or discouraged) by the Void Linux project.
This guide is for experienced Linux users.}}

This will not be a complete guide, as it borrows heavily on [[Installing Arch Linux ARM On The Pinebook Pro]], so read it first then come back here.

Only the steps that are different are listed here. Be careful, the numbering of the sections is not the same.

=== Downloading and verifying the rootfs tarball ===

You can go to the Void linux [https://voidlinux.org/download/ download page], select the "arm" tab, and choose one of the aarch64 rootfs tarballs, either glibc or musl.
How to check integrity of the downloaded file is explained on the same page.

Or use the following instructions (on debian):
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/void-aarch64-musl-ROOTFS-20221001.tar.xz</nowiki>
<nowiki>$ wget https://repo-default.voidlinux.org/live/current/sha256sum.{txt,sig}</nowiki>
<nowiki>$ wget https://github.com/void-linux/void-packages/raw/master/srcpkgs/void-release-keys/files/void-release-20221001.pub</nowiki>
$ signify-openbsd -V -p void-release-20221001.pub -x sha256sum.sig -m sha256sum.txt
Signature Verified
$ sha256sum -c --ignore-missing sha256sum.txt
void-aarch64-musl-ROOTFS-20221001.tar.xz: OK

=== Extracting and configuring the root filesystem ===
==== Extracting the root filesystem ====
# tar -xpf void-aarch64-musl-ROOTFS-20221001.tar.xz -C /mnt

==== Configuring a login agent on the serial console ====
# cp -R /mnt/etc/sv/agetty-ttyS0 /mnt/etc/sv/agetty-ttyS2
# ln -sf /etc/sv/agetty-ttyS2 /mnt/etc/runit/runsvdir/default

=== Kernel ===
The Void linux rootfs tarball does not contain a kernel. We'll cross-build one ourselves.

=== Cross-compiling a mainline kernel suitable for the Pinebook Pro ===
We'll use the PostmarketOS kernel configuration and boot parameters, because they are working properly, and are sufficiently up-to-date. This is done from an x86_64 computer.

This has been tested with PMOS configuration for 6.0.2 and kernel 6.1.0-rc5+. No initramfs was needed to boot the OS.

$ git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$ cd linux
$ wget -O .config https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/linux-postmarketos-rockchip/config-postmarketos-rockchip.aarch64
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 oldconfig
$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j$(grep -c '^processor' /proc/cpuinfo)

=== Installing the newly built kernel, modules & DTB files ===

$ KVER="$(make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 kernelrelease)"
$ sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j1 modules_install dtbs_install \
INSTALL_MOD_STRIP=1 \
INSTALL_MOD_PATH=/mnt \
INSTALL_DTBS_PATH=/mnt/boot/dtbs
$ sudo cp arch/arm64/boot/Image "/mnt/boot/Image-${KVER}"

=== Configuring tow-boot with extlinux.conf===
The following borrows from [https://gitlab.com/postmarketOS/pmaports/-/blob/master/device/community/device-pine64-pinebookpro/extlinux.conf PostmarketOS u-boot configuration for the kernel command-line parameters].

We force the serial console to 115200 bauds (from the default 1.5M bauds), so that it is the same as tow-boot's.

# mkdir -p /mnt/boot/extlinux
# cat <<EOF > /mnt/boot/extlinux/extlinux.conf
default l0
menu title Pinebook Pro Boot Menu
prompt 0
timeout 50

label l0
menu label Boot Kernel on SD
linux /Image-${KVER}
fdt /dtbs/rockchip/rk3399-pinebook-pro.dtb
append console=tty0 console=ttyS2,115200n8 coherent_pool=1M pcie_aspm.policy=performance video=HDMI-A-1:1920x1080@60 video=eDP-1:1920x1080@60 rw rootwait root=/dev/mmcblk1p3
EOF

=== Finalizing ===
Now you can umount the partition(s) and boot the Pinebook Pro with Void Linux.

Quartz64

2022-11-14T01:19:21Z

CameronNemo: Fix typo

[[File:Quartz64modelb.png|400px|thumb|right|The Quartz64 Model B]]

The '''Quartz64''' is the most recent Single Board Computer offering from PINE64, with Model A initially released in June of 2021 and Model B in May of 2022. 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 releases ==

{{warning|Software for the Quartz64 is still early in development, and therefore currently lacks features such as the ability to produce video output. You are strongly encouraged to procure a 3.3V UART serial adapter capable of running at 1.5 mbauds, such as [https://pine64.com/product/serial-console-woodpecker-edition/ the woodpecker] if you want to use a Quartz64 at this stage.}}
{{note|'''Note:''' OS images are provided by the community, not by PINE64. Most community projects currently aim at getting mainline Linux running on the board, not some vendor provided kernel that will never be receiving updates. A mainline-first approach allows for the boards to continue receiving important updates, such as security updates, for years to come, as well as have higher quality code in the kernel as it underwent independent review, but does mean that not all aspects of the hardware work right out of the gate.}}

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

Armbian is a base operating system platform for single board computers

* Lightweight Debian or Ubuntu based Linux distribution specialised for ARM development boards
* Each system is compiled, assembled and optimised by [https://github.com/armbian/build Armbian Build Tools]
* It has powerful build and software development tools to make custom builds

Download [https://github.com/armbian/build/releases/ latest, as fresh as possible, upon code change, images]

Support on Armbian forums https://forum.armbian.com/forum/96-upcoming-hardware-wip/

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

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

* [https://github.com/manjaro-arm/quartz64-a-images/releases Images for Model A on GitHub]
* [https://github.com/manjaro-arm/quartz64-b-images/releases Images for Model B on GitHub]

Most of the hardware support is already available in the mainline kernel. If some devices doesn't work it is possible to swap to the linux-quartz64 kernel <code>pacman -S linux-quartz64</code>.

Following desktop options available:
* Gnome
* KDE Plasma
* Mate
* Sway
* XFCE
as well as minimal image without desktop.

=== pgwipeout's Quartz64 CI ===

pgwipeout provides continuously rebuilt set of images for Quartz64 devices which includes a Debian installer and a buildroot rescue environment. It is aimed at advanced users who generally know their way around a Linux system, and as a baseline for whether something is working or not. Works on both SD cards and eMMC, uses pgwipeout's patched kernel. Kernels aren't auto-updated on the installed system, so the user manually has to do this by mounting the actual correct boot partition.

'''Download:''' https://gitlab.com/pgwipeout/quartz64_ci/-/pipelines (Click the three dots on the right, download the merge-job archive.)

For Quartz64 Model A, flash <tt>rk3566-quartz64-a.dtb.img.xz</tt>. On Linux, you can for example do this as follows, assuming your target device is <tt>/dev/sdX</tt>:

sudo -i; xzcat /path/to/rk3566-quartz64-a.dtb.img.xz > /dev/sdX

For Quartz64 Model B, use <tt>rk3566-quartz64-b.dtb.img.xz</tt> instead.

For line by line instructions to boot Quartz64 CI on a microSD card and use it to install Debian onto an eMMC follow these instructions https://wiki.pine64.org/wiki/Installing_Debian_on_the_Quartz64

=== DietPi ===
<div style=float:right>[[File:dietpi.png|center|100px]]</div>

* 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 Quartz64 build(s) on the [https://forum.pine64.org/showthread.php?tid=17601 PINE64 forum thread].
* DD image (for 4 GiB or above micro SD card or eMMC)
** Quartz64 Model A: [https://dietpi.com/downloads/images/DietPi_Quartz64A-ARMv8-Bullseye.7z Direct download from dietpi.com]
** Quartz64 Model B: [https://dietpi.com/downloads/images/DietPi_Quartz64B-ARMv8-Bullseye.7z Direct download from dietpi.com]
** SOQuartz: [https://dietpi.com/downloads/images/DietPi_SOQuartz-ARMv8-Bullseye.7z Direct download from dietpi.com]
* Login with
** Username: '''root'''
** Password: '''dietpi'''

=== Arch Linux ARM (Unofficial) ===

See [[Installing Arch Linux ARM On The Quartz64]] for detailed instructions.

=== Tianocore EDK II port by jmcneill ===

This (as of 2021-12-30) is a work in progress to enable UEFI enabled systems, and is able to bring up SD, eMMC, USB, PCIe with SATA and NVMe, HDMI, thermal sensors, TRNG, as well as general Cortex A-55 features. Known to work with NetBSD -current, and the ESXi Arm fling version 1.8.

* [https://github.com/jaredmcneill/quartz64_uefi jmcneill's Quartz64 UEFI Github]

The sdcard image should be written to an microSD card and installed. Currently, using this card also for the OS may be problematic.

=== NetBSD ===

NetBSD relies upon the UEFI support in Tianocore. Before NetBSD 10 is released, the latest version of NetBSD-current should be used:

* [http://nycdn.netbsd.org/pub/NetBSD-daily/HEAD/ NetBSD daily builds top level] from inside here, navigate to a date, and inside the images/ subdirectory are installable images. Use the one called "NetBSD-<version>-evbarm-aarch64-install.img.gz". This image can be written to a supported device, such as the eMMC interface, any USB storage device, NVMe, and PCIe AHCI SATA are all supported with builds after 2022-01-15.

* Currently this can not be shared with the EDK2 port, ie, microSD for EDK2 and some other media for NetBSD.

== 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
* [https://www.cnx-software.com/2020/12/01/rockchip-rk3568-processor-to-power-edge-computing-and-nvr-applications 22nm process, believed to be FD-SOI]

=== 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: 2GB (SOQuartz only), 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 8GB up to 128GB
* 64 Mbit (8 MByte) SPI flash (Model B only), part number <tt>25Q64DWZPIG</tt> in the schematic

==== eMMC Speeds ====

On a 64 GB eMMC module:

$ sudo hdparm -tT /dev/mmcblk1

/dev/mmcblk1:
Timing cached reads: 2368 MB in 2.00 seconds = 1184.46 MB/sec
Timing buffered disk reads: 452 MB in 3.01 seconds = 149.98 MB/sec

=== 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
** On Model A, the slot provides 10W of power for the 3.3V supply and however much power your 12V input power supply provides on the 12V supply

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).

==== Combo PHYs ====

[[File:rk3566 phy.png]]

Several of the I/O options on the RK3566 used in the Quartz64 are using the same I/O lines, 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 no.
! scope="col" | Pin no.
! 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].

=== GPIO Pins (Quartz64 Model B) ===

Attention! GPIOs are 3.3V!

Interesting alternate pin configurations are listed in [brackets].

{| class="wikitable plainrowheaders" border="1"
! scope="col" style="width:20em;" | Assigned To
! scope="col" | Pin no.
! scope="col" | Pin no.
! scope="col" style="width:20em;" | Assigned To
|-
| style="text-align:right;"| 3.3 V
| style="text-align:center; background-color:yellow; color:black; font-weight:bold;"| 1
| style="text-align:center; background-color:red; color:gold; font-weight:bold;"| 2
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| ''[I2C3_SDA_M0]'' GPIO1_A0_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 3
| style="text-align:center; background-color:red; color:gold; font-weight:bold;"| 4
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| ''[I2C3_SCL_M0]'' GPIO1_A1_3V3
| style="text-align:center; background-color:green; 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;"| GPIO3_C4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 7
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 8
| style="text-align:left;"| UART2_TX
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 9
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 10
| style="text-align:left;"| UART2_RX
|-
| style="text-align:right;"| ''[SPI1_CS0_M1]'' GPIO3_A1_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 11
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 12
| style="text-align:left;"| GPIO3_A3_3V3
|-
| style="text-align:right;"| GPIO3_A2_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 13
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 14
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_B0_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 15
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 16
| style="text-align:left;"| GPIO3_B1_3V3
|-
| style="text-align:right;"| 3.3V
| style="text-align:center; background-color:yellow; color:black; font-weight:bold;"| 17
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 18
| style="text-align:left;"| GPIO3_B2_3V3
|-
| style="text-align:right;"| GPIO4_C3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 19
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 20
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO4_C5_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 21
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 22
| style="text-align:left;"| GPIO3_C1_3V3 ''[SPI1_MOSI_M1]''
|-
| style="text-align:right;"| GPIO4_C2_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 23
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 24
| style="text-align:left;"| GPIO4_C6_3V3
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 25
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 26
| style="text-align:left;"| GPIO4_D1_3V3
|-
| style="text-align:right;"| I2C4_SDA_M0
| style="text-align:center; background-color:blue; color:gold; font-weight:bold;"| 27
| style="text-align:center; background-color:blue; color:gold; font-weight:bold;"| 28
| style="text-align:left;"| I2C4_SCL_M0
|-
| style="text-align:right;"| GPIO3_B3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 29
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 30
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_B4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 31
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 32
| style="text-align:left;"| GPIO3_C2_3V3 ''[SPI1_MISO_M1]''
|-
| style="text-align:right;"| ''[SPI1_CLK_M1]'' GPIO3_C3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 33
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 34
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_A4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 35
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 36
| style="text-align:left;"| GPIO3_A7_3V3
|-
| style="text-align:right;"| ''[SPDIF_TX_M0]'' GPIO1_A4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 37
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 38
| style="text-align:left;"| GPIO3_A6_3V3
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 39
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 40
| style="text-align:left;"| GPIO3_A5_3V3
|}

Source: Page 24 of [https://files.pine64.org/doc/quartz64/Quartz64_model-B_Schematic-V1.3_20220124.pdf the board schematics].

== Quartz64 Board Information, Schematics, and Certifications ==

=== Model "A" ===
* 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]

* 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 CE Certificate]
** [https://files.pine64.org/doc/cert/Quartz64%20Model-A%20FCC%20certification-S21051101702001.pdf Quartz64 model-A FCC Certificate]

=== Model "B" ===

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

* Quartz64 Model "B" SBC Schematic and PCB Board Resource:
** [https://files.pine64.org/doc/quartz64/Quartz64_model-B_Schematic-V1.3_20220124.pdf Quartz64 Model "B" SBC Schematic ver 1.3 20220124 PDF file]
** [https://files.pine64.org/doc/quartz64/Quartz64_model-B_PCB_Components_Placement-V1.2_20211014.pdf Quartz64 Model "B" SBC PCB Connector placement PDF file]
* Please note that v1.2 and V1.3 schematic and component placement are identical, just some component value changed.

* Note: Model B uses a Molex PicoBlade compatible connector for the RTC battery. The Pine64 Backup Battery Holders come with a JST PH type connector. To use the Pine64 RTC Backup Battery Holder, the connector on the battery holder will need to be modified with a PicoBlade type connector.

== 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]
** [https://opensource.rock-chips.com/images/2/26/Rockchip_RK3568_TRM_Part1_V1.3-20220930P.PDF Rockchip RK3566 and RK3568 TRM (Technical Reference Manual)]
* Rockchip PMU (Power Management Unit) Information:
** [https://www.rockchip.fr/RK817%20datasheet%20V1.01.pdf Rockchip RK817 ver 1.01 datasheet for Quartz64 model A]
** [https://www.rockchip.fr/RK809%20datasheet%20V1.01.pdf Rockchip RK809 ver 1.01 datasheet for Quartz64 model B and SOQuartz]
* 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]
** [https://files.pine64.org/doc/datasheet/PineNote/TI%20PMU-TPS651851.pdf TPS65185x PMIC for E-Ink Enabled Electronic Paper Display Datasheet]
* 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/AW-CM256SM_DS_DF_V1.9_STD.pdf Azurewave CM256SM 11AC WiFi + Bluetooth5.0 Datasheet]
* IR LED:
** [https://media.digikey.com/pdf/Data%20Sheets/Everlight%20PDFs/IRM-36xx_Series.pdf IRM-3638 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]
** [https://www.printables.com/model/269572-pine-quartz-64-a-full-case 3D Printable Enclosure for Model A]
** [https://www.printables.com/model/269575-pine-quartz-64-a-open-frame Open Frame for Model A]
* Connector information:
** [https://files.pine64.org/doc/datasheet/pine64/ePH.pdf 2.0mm PH Type connector specification use in Lithium Battery (VBAT) port (Model A)]
** [https://www.molex.com/pdm_docs/sd/533980271_sd.pdf 1.25mm Picoblade Type connector specification used in RTC Battery port (Model B)]
** [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 Quartz64 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 Quartz64 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 Quartz64 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 Quartz64 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 Quartz64 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]]

== Enclosures ==

(Please expand this section with more cases known to work.)

=== Model "A" ===

All enclosures that fit the ROCKPro64 should fit the Quartz64 Model "A", as the I/O has been laid out the same on purpose.

* [["Model A" Acrylic Open Enclosure]] - but see the troubleshooting section below.
* [[ROCKPro64 ABS Enclosure]]
* [[Quartz64PremiumAluminiumCase|RockPro64 Premium Aluminium Case]]
* [[ROCKPro64#3D_printable_ITX_mounting_brackets]] (Not an enclosure but allows to mount the board in an ATX/ITX case)

=== Model "B" ===

* [["Model B" Acrylic Open Enclosure]]
* the ROCK64 aluminium enclosure '''does not''' work, as the DC input jack is placed differently

== 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, because if the generic PHY driver is built in it will bind to the PHY first, unless you include the motorcomm module in your initramfs.

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

The Quartz64 does not really fit onto the bottom plate of the [["Model A" Acrylic Open Enclosure]]. 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.

[[File:Quartz64-audio-jack-spacer-issue.jpg]]

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.

=== No GPU Acceleration with Debian "Bullseye" Userland ===

Debian Bullseye ships a Mesa version that is too old to contain the required patches for the RK356x SoC's GPU. You can (at your own risk) [https://wiki.debian.org/DebianTesting use the current Debian Testing version ], called "Bookworm".

=== Wireless Connectivity Doesn't Work ===

ROCKPro64 wireless module may have CYW43455 or CYW43456 chips on board (not sure if this is the same for Quartz64 model B). Both chips are supported by <code>brcmfmac</code> wi-fi driver and <code>btbcm</code> bluetooth driver.

For CYW43455 drivers attempt to load <code>/lib/firmware/brcm/brcmfmac43455-sdio.bin</code> for wi-fi and <code>/lib/firmware/brcm/BCM4345C0.hcd</code> for bluetooth. Corresponding firmware files for CYW43456 are <code>/lib/firmware/brcm/brcmfmac43456-sdio.bin</code> and <code>/lib/firmware/brcm/BCM4345C5.hcd</code>.

On Manjaro firmware files for both bluetooth and wi-fi on CYW43456 on are provided by <code>ap6256-firmware</code> package (<code>pacman -S ap6256-firmware</code>).

However for CYW43455 wi-fi firmware is in the <code>linux-firmware</code> package and bluetooth is in the <code>firmware-raspberrypi</code> (<code>pacman -S linux-firmware firmware-raspberrypi</code>). <code>linux-firmware</code> package is missing device specific symlinks for quartz64-a. To create them execute:
# ln -s brcmfmac43455-sdio.bin /lib/firmware/brcm/brcmfmac43455-sdio.pine64,quartz64-a.bin
# ln -s brcmfmac43455-sdio.AW-CM256SM.txt /lib/firmware/brcm/brcmfmac43455-sdio.pine64,quartz64-a.txt

As of 2022-10-19 device tree in mainline kernel for Quartz64 model A has wrong configuration for the bluetooth driver. [https://patchwork.kernel.org/project/linux-rockchip/patch/20220926125350.64783-1-leo@nabam.net/ Patch] is submitted to the LKML. It's possible to modify dtb file provided by the current kernel using device tree compiler to enable bluetooth or perform <code>make dtbs</code> in the patched kernel tree to get updated dtb file (<code>arch/arm64/boot/dts/rockchip/rk3566-quartz64-a.dtb</code>). Issue manifests itself with following errors in `dmesg`:

command 0x0c03 tx timeout
Bluetooth: hci0: BCM: Reset failed (-110)

== How-To ==

=== Connect Debug UART ===

The easiest way to get debug output is to connect a 3.3V 1.5mbaud capable UART adapter to the board.

To connect it, connect the ground lead to pin 6, and the RX/TX leads to pins 8 and 10 (consider swapping them if you get no output, things are often mislabelled). These pins are "UART2" in the above GPIO table.

Open a serial terminal at 1500000 bauds, e.g.

$ picocom -b 1500000 /dev/ttyUSB0

=== Disable Heartbeat LED (Linux) ===

The flashing LED is called the "heartbeat LED", it blinks in a heart rhythm like fashion once the kernel is running. To disable it, you can run

# echo none > /sys/class/leds/user-led/trigger

On model A LED device is called "diy-led", not "user-led".

On a system with systemd, you can do this as soon as the system is ready to be logged in with a systemd unit like this:

[Unit]
Description=Turn off heartbeat LED
Wants=multi-user.target
After=multi-user.target

[Install]
WantedBy=multi-user.target

[Service]
Type=simple
ExecStart=sh -c 'echo none > /sys/class/leds/user-led/trigger'

Place it in <tt>/etc/systemd/system/user-led.service</tt>, and run

# systemctl daemon-reload
# systemctl enable user-led.service

Upon rebooting, you will now notice that the heartbeat LED will blink during boot-up, but stops blinking as soon as the multi-user target is reached (i.e. the user can log in).

=== SATA on model A ===

On model A USB 3.0 and SATA ports are using the same I/O line and can't be used simultaneously. By default USB 3.0 is enabled in linux device tree and SATA is disabled. FDT modifications are required to turn SATA on.

Following script is tested on Monjaro but should work on the other distros with minimal changes. Device tree compiler package usually provides fdtput command (on Manjaro run: <code> pacman -S dtc</code>)

# cp /boot/dtbs/rockchip/rk3566-quartz64-a.dtb /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb
# fdtput -t s -v /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb /usb@fd000000 status disabled
# fdtput -t s -v /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb /sata@fc400000 status okay
# sed -i 's#^FDT /dtbs/rockchip/rk3566-quartz64-a.dtb$#FDT /dtbs/rockchip/rk3566-quartz64-a-sata.dtb#' /boot/extlinux/extlinux.conf
# systemctl reboot

[[Category:Quartz64]]

Quartz64

2022-11-14T01:18:40Z

CameronNemo: Fix forum link for dietpi

[[File:Quartz64modelb.png|400px|thumb|right|The Quartz64 Model B]]

The '''Quartz64''' is the most recent Single Board Computer offering from PINE64, with Model A initially released in June of 2021 and Model B in May of 2022. 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 releases ==

{{warning|Software for the Quartz64 is still early in development, and therefore currently lacks features such as the ability to produce video output. You are strongly encouraged to procure a 3.3V UART serial adapter capable of running at 1.5 mbauds, such as [https://pine64.com/product/serial-console-woodpecker-edition/ the woodpecker] if you want to use a Quartz64 at this stage.}}
{{note|'''Note:''' OS images are provided by the community, not by PINE64. Most community projects currently aim at getting mainline Linux running on the board, not some vendor provided kernel that will never be receiving updates. A mainline-first approach allows for the boards to continue receiving important updates, such as security updates, for years to come, as well as have higher quality code in the kernel as it underwent independent review, but does mean that not all aspects of the hardware work right out of the gate.}}

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

Armbian is a base operating system platform for single board computers

* Lightweight Debian or Ubuntu based Linux distribution specialised for ARM development boards
* Each system is compiled, assembled and optimised by [https://github.com/armbian/build Armbian Build Tools]
* It has powerful build and software development tools to make custom builds

Download [https://github.com/armbian/build/releases/ latest, as fresh as possible, upon code change, images]

Support on Armbian forums https://forum.armbian.com/forum/96-upcoming-hardware-wip/

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

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

* [https://github.com/manjaro-arm/quartz64-a-images/releases Images for Model A on GitHub]
* [https://github.com/manjaro-arm/quartz64-b-images/releases Images for Model B on GitHub]

Most of the hardware support is already available in the mainline kernel. If some devices doesn't work it is possible to swap to the linux-quartz64 kernel <code>pacman -S linux-quartz64</code>.

Following desktop options available:
* Gnome
* KDE Plasma
* Mate
* Sway
* XFCE
as well as minimal image without desktop.

=== pgwipeout's Quartz64 CI ===

pgwipeout provides continuously rebuilt set of images for Quartz64 devices which includes a Debian installer and a buildroot rescue environment. It is aimed at advanced users who generally know their way around a Linux system, and as a baseline for whether something is working or not. Works on both SD cards and eMMC, uses pgwipeout's patched kernel. Kernels aren't auto-updated on the installed system, so the user manually has to do this by mounting the actual correct boot partition.

'''Download:''' https://gitlab.com/pgwipeout/quartz64_ci/-/pipelines (Click the three dots on the right, download the merge-job archive.)

For Quartz64 Model A, flash <tt>rk3566-quartz64-a.dtb.img.xz</tt>. On Linux, you can for example do this as follows, assuming your target device is <tt>/dev/sdX</tt>:

sudo -i; xzcat /path/to/rk3566-quartz64-a.dtb.img.xz > /dev/sdX

For Quartz64 Model B, use <tt>rk3566-quartz64-b.dtb.img.xz</tt> instead.

For line by line instructions to boot Quartz64 CI on a microSD card and use it to install Debian onto an eMMC follow these instructions https://wiki.pine64.org/wiki/Installing_Debian_on_the_Quartz64

=== DietPi ===
<div style=float:right>[[File:dietpi.png|center|100px]]</div>

* 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 Qurtz64 build(s) on the [https://forum.pine64.org/showthread.php?tid=17601 PINE64 forum thread].
* DD image (for 4 GiB or above micro SD card or eMMC)
** Quartz64 Model A: [https://dietpi.com/downloads/images/DietPi_Quartz64A-ARMv8-Bullseye.7z Direct download from dietpi.com]
** Quartz64 Model B: [https://dietpi.com/downloads/images/DietPi_Quartz64B-ARMv8-Bullseye.7z Direct download from dietpi.com]
** SOQuartz: [https://dietpi.com/downloads/images/DietPi_SOQuartz-ARMv8-Bullseye.7z Direct download from dietpi.com]
* Login with
** Username: '''root'''
** Password: '''dietpi'''

=== Arch Linux ARM (Unofficial) ===

See [[Installing Arch Linux ARM On The Quartz64]] for detailed instructions.

=== Tianocore EDK II port by jmcneill ===

This (as of 2021-12-30) is a work in progress to enable UEFI enabled systems, and is able to bring up SD, eMMC, USB, PCIe with SATA and NVMe, HDMI, thermal sensors, TRNG, as well as general Cortex A-55 features. Known to work with NetBSD -current, and the ESXi Arm fling version 1.8.

* [https://github.com/jaredmcneill/quartz64_uefi jmcneill's Quartz64 UEFI Github]

The sdcard image should be written to an microSD card and installed. Currently, using this card also for the OS may be problematic.

=== NetBSD ===

NetBSD relies upon the UEFI support in Tianocore. Before NetBSD 10 is released, the latest version of NetBSD-current should be used:

* [http://nycdn.netbsd.org/pub/NetBSD-daily/HEAD/ NetBSD daily builds top level] from inside here, navigate to a date, and inside the images/ subdirectory are installable images. Use the one called "NetBSD-<version>-evbarm-aarch64-install.img.gz". This image can be written to a supported device, such as the eMMC interface, any USB storage device, NVMe, and PCIe AHCI SATA are all supported with builds after 2022-01-15.

* Currently this can not be shared with the EDK2 port, ie, microSD for EDK2 and some other media for NetBSD.

== 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
* [https://www.cnx-software.com/2020/12/01/rockchip-rk3568-processor-to-power-edge-computing-and-nvr-applications 22nm process, believed to be FD-SOI]

=== 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: 2GB (SOQuartz only), 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 8GB up to 128GB
* 64 Mbit (8 MByte) SPI flash (Model B only), part number <tt>25Q64DWZPIG</tt> in the schematic

==== eMMC Speeds ====

On a 64 GB eMMC module:

$ sudo hdparm -tT /dev/mmcblk1

/dev/mmcblk1:
Timing cached reads: 2368 MB in 2.00 seconds = 1184.46 MB/sec
Timing buffered disk reads: 452 MB in 3.01 seconds = 149.98 MB/sec

=== 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
** On Model A, the slot provides 10W of power for the 3.3V supply and however much power your 12V input power supply provides on the 12V supply

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).

==== Combo PHYs ====

[[File:rk3566 phy.png]]

Several of the I/O options on the RK3566 used in the Quartz64 are using the same I/O lines, 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 no.
! scope="col" | Pin no.
! 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].

=== GPIO Pins (Quartz64 Model B) ===

Attention! GPIOs are 3.3V!

Interesting alternate pin configurations are listed in [brackets].

{| class="wikitable plainrowheaders" border="1"
! scope="col" style="width:20em;" | Assigned To
! scope="col" | Pin no.
! scope="col" | Pin no.
! scope="col" style="width:20em;" | Assigned To
|-
| style="text-align:right;"| 3.3 V
| style="text-align:center; background-color:yellow; color:black; font-weight:bold;"| 1
| style="text-align:center; background-color:red; color:gold; font-weight:bold;"| 2
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| ''[I2C3_SDA_M0]'' GPIO1_A0_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 3
| style="text-align:center; background-color:red; color:gold; font-weight:bold;"| 4
| style="text-align:left;"| 5 V
|-
| style="text-align:right;"| ''[I2C3_SCL_M0]'' GPIO1_A1_3V3
| style="text-align:center; background-color:green; 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;"| GPIO3_C4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 7
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 8
| style="text-align:left;"| UART2_TX
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 9
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 10
| style="text-align:left;"| UART2_RX
|-
| style="text-align:right;"| ''[SPI1_CS0_M1]'' GPIO3_A1_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 11
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 12
| style="text-align:left;"| GPIO3_A3_3V3
|-
| style="text-align:right;"| GPIO3_A2_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 13
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 14
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_B0_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 15
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 16
| style="text-align:left;"| GPIO3_B1_3V3
|-
| style="text-align:right;"| 3.3V
| style="text-align:center; background-color:yellow; color:black; font-weight:bold;"| 17
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 18
| style="text-align:left;"| GPIO3_B2_3V3
|-
| style="text-align:right;"| GPIO4_C3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 19
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 20
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO4_C5_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 21
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 22
| style="text-align:left;"| GPIO3_C1_3V3 ''[SPI1_MOSI_M1]''
|-
| style="text-align:right;"| GPIO4_C2_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 23
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 24
| style="text-align:left;"| GPIO4_C6_3V3
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 25
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 26
| style="text-align:left;"| GPIO4_D1_3V3
|-
| style="text-align:right;"| I2C4_SDA_M0
| style="text-align:center; background-color:blue; color:gold; font-weight:bold;"| 27
| style="text-align:center; background-color:blue; color:gold; font-weight:bold;"| 28
| style="text-align:left;"| I2C4_SCL_M0
|-
| style="text-align:right;"| GPIO3_B3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 29
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 30
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_B4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 31
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 32
| style="text-align:left;"| GPIO3_C2_3V3 ''[SPI1_MISO_M1]''
|-
| style="text-align:right;"| ''[SPI1_CLK_M1]'' GPIO3_C3_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 33
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 34
| style="text-align:left;"| GND
|-
| style="text-align:right;"| GPIO3_A4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 35
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 36
| style="text-align:left;"| GPIO3_A7_3V3
|-
| style="text-align:right;"| ''[SPDIF_TX_M0]'' GPIO1_A4_3V3
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 37
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 38
| style="text-align:left;"| GPIO3_A6_3V3
|-
| style="text-align:right;"| GND
| style="text-align:center; background-color:black; color:gold; font-weight:bold;"| 39
| style="text-align:center; background-color:green; color:gold; font-weight:bold;"| 40
| style="text-align:left;"| GPIO3_A5_3V3
|}

Source: Page 24 of [https://files.pine64.org/doc/quartz64/Quartz64_model-B_Schematic-V1.3_20220124.pdf the board schematics].

== Quartz64 Board Information, Schematics, and Certifications ==

=== Model "A" ===
* 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]

* 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 CE Certificate]
** [https://files.pine64.org/doc/cert/Quartz64%20Model-A%20FCC%20certification-S21051101702001.pdf Quartz64 model-A FCC Certificate]

=== Model "B" ===

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

* Quartz64 Model "B" SBC Schematic and PCB Board Resource:
** [https://files.pine64.org/doc/quartz64/Quartz64_model-B_Schematic-V1.3_20220124.pdf Quartz64 Model "B" SBC Schematic ver 1.3 20220124 PDF file]
** [https://files.pine64.org/doc/quartz64/Quartz64_model-B_PCB_Components_Placement-V1.2_20211014.pdf Quartz64 Model "B" SBC PCB Connector placement PDF file]
* Please note that v1.2 and V1.3 schematic and component placement are identical, just some component value changed.

* Note: Model B uses a Molex PicoBlade compatible connector for the RTC battery. The Pine64 Backup Battery Holders come with a JST PH type connector. To use the Pine64 RTC Backup Battery Holder, the connector on the battery holder will need to be modified with a PicoBlade type connector.

== 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]
** [https://opensource.rock-chips.com/images/2/26/Rockchip_RK3568_TRM_Part1_V1.3-20220930P.PDF Rockchip RK3566 and RK3568 TRM (Technical Reference Manual)]
* Rockchip PMU (Power Management Unit) Information:
** [https://www.rockchip.fr/RK817%20datasheet%20V1.01.pdf Rockchip RK817 ver 1.01 datasheet for Quartz64 model A]
** [https://www.rockchip.fr/RK809%20datasheet%20V1.01.pdf Rockchip RK809 ver 1.01 datasheet for Quartz64 model B and SOQuartz]
* 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]
** [https://files.pine64.org/doc/datasheet/PineNote/TI%20PMU-TPS651851.pdf TPS65185x PMIC for E-Ink Enabled Electronic Paper Display Datasheet]
* 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/AW-CM256SM_DS_DF_V1.9_STD.pdf Azurewave CM256SM 11AC WiFi + Bluetooth5.0 Datasheet]
* IR LED:
** [https://media.digikey.com/pdf/Data%20Sheets/Everlight%20PDFs/IRM-36xx_Series.pdf IRM-3638 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]
** [https://www.printables.com/model/269572-pine-quartz-64-a-full-case 3D Printable Enclosure for Model A]
** [https://www.printables.com/model/269575-pine-quartz-64-a-open-frame Open Frame for Model A]
* Connector information:
** [https://files.pine64.org/doc/datasheet/pine64/ePH.pdf 2.0mm PH Type connector specification use in Lithium Battery (VBAT) port (Model A)]
** [https://www.molex.com/pdm_docs/sd/533980271_sd.pdf 1.25mm Picoblade Type connector specification used in RTC Battery port (Model B)]
** [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 Quartz64 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 Quartz64 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 Quartz64 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 Quartz64 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 Quartz64 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]]

== Enclosures ==

(Please expand this section with more cases known to work.)

=== Model "A" ===

All enclosures that fit the ROCKPro64 should fit the Quartz64 Model "A", as the I/O has been laid out the same on purpose.

* [["Model A" Acrylic Open Enclosure]] - but see the troubleshooting section below.
* [[ROCKPro64 ABS Enclosure]]
* [[Quartz64PremiumAluminiumCase|RockPro64 Premium Aluminium Case]]
* [[ROCKPro64#3D_printable_ITX_mounting_brackets]] (Not an enclosure but allows to mount the board in an ATX/ITX case)

=== Model "B" ===

* [["Model B" Acrylic Open Enclosure]]
* the ROCK64 aluminium enclosure '''does not''' work, as the DC input jack is placed differently

== 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, because if the generic PHY driver is built in it will bind to the PHY first, unless you include the motorcomm module in your initramfs.

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

The Quartz64 does not really fit onto the bottom plate of the [["Model A" Acrylic Open Enclosure]]. 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.

[[File:Quartz64-audio-jack-spacer-issue.jpg]]

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.

=== No GPU Acceleration with Debian "Bullseye" Userland ===

Debian Bullseye ships a Mesa version that is too old to contain the required patches for the RK356x SoC's GPU. You can (at your own risk) [https://wiki.debian.org/DebianTesting use the current Debian Testing version ], called "Bookworm".

=== Wireless Connectivity Doesn't Work ===

ROCKPro64 wireless module may have CYW43455 or CYW43456 chips on board (not sure if this is the same for Quartz64 model B). Both chips are supported by <code>brcmfmac</code> wi-fi driver and <code>btbcm</code> bluetooth driver.

For CYW43455 drivers attempt to load <code>/lib/firmware/brcm/brcmfmac43455-sdio.bin</code> for wi-fi and <code>/lib/firmware/brcm/BCM4345C0.hcd</code> for bluetooth. Corresponding firmware files for CYW43456 are <code>/lib/firmware/brcm/brcmfmac43456-sdio.bin</code> and <code>/lib/firmware/brcm/BCM4345C5.hcd</code>.

On Manjaro firmware files for both bluetooth and wi-fi on CYW43456 on are provided by <code>ap6256-firmware</code> package (<code>pacman -S ap6256-firmware</code>).

However for CYW43455 wi-fi firmware is in the <code>linux-firmware</code> package and bluetooth is in the <code>firmware-raspberrypi</code> (<code>pacman -S linux-firmware firmware-raspberrypi</code>). <code>linux-firmware</code> package is missing device specific symlinks for quartz64-a. To create them execute:
# ln -s brcmfmac43455-sdio.bin /lib/firmware/brcm/brcmfmac43455-sdio.pine64,quartz64-a.bin
# ln -s brcmfmac43455-sdio.AW-CM256SM.txt /lib/firmware/brcm/brcmfmac43455-sdio.pine64,quartz64-a.txt

As of 2022-10-19 device tree in mainline kernel for Quartz64 model A has wrong configuration for the bluetooth driver. [https://patchwork.kernel.org/project/linux-rockchip/patch/20220926125350.64783-1-leo@nabam.net/ Patch] is submitted to the LKML. It's possible to modify dtb file provided by the current kernel using device tree compiler to enable bluetooth or perform <code>make dtbs</code> in the patched kernel tree to get updated dtb file (<code>arch/arm64/boot/dts/rockchip/rk3566-quartz64-a.dtb</code>). Issue manifests itself with following errors in `dmesg`:

command 0x0c03 tx timeout
Bluetooth: hci0: BCM: Reset failed (-110)

== How-To ==

=== Connect Debug UART ===

The easiest way to get debug output is to connect a 3.3V 1.5mbaud capable UART adapter to the board.

To connect it, connect the ground lead to pin 6, and the RX/TX leads to pins 8 and 10 (consider swapping them if you get no output, things are often mislabelled). These pins are "UART2" in the above GPIO table.

Open a serial terminal at 1500000 bauds, e.g.

$ picocom -b 1500000 /dev/ttyUSB0

=== Disable Heartbeat LED (Linux) ===

The flashing LED is called the "heartbeat LED", it blinks in a heart rhythm like fashion once the kernel is running. To disable it, you can run

# echo none > /sys/class/leds/user-led/trigger

On model A LED device is called "diy-led", not "user-led".

On a system with systemd, you can do this as soon as the system is ready to be logged in with a systemd unit like this:

[Unit]
Description=Turn off heartbeat LED
Wants=multi-user.target
After=multi-user.target

[Install]
WantedBy=multi-user.target

[Service]
Type=simple
ExecStart=sh -c 'echo none > /sys/class/leds/user-led/trigger'

Place it in <tt>/etc/systemd/system/user-led.service</tt>, and run

# systemctl daemon-reload
# systemctl enable user-led.service

Upon rebooting, you will now notice that the heartbeat LED will blink during boot-up, but stops blinking as soon as the multi-user target is reached (i.e. the user can log in).

=== SATA on model A ===

On model A USB 3.0 and SATA ports are using the same I/O line and can't be used simultaneously. By default USB 3.0 is enabled in linux device tree and SATA is disabled. FDT modifications are required to turn SATA on.

Following script is tested on Monjaro but should work on the other distros with minimal changes. Device tree compiler package usually provides fdtput command (on Manjaro run: <code> pacman -S dtc</code>)

# cp /boot/dtbs/rockchip/rk3566-quartz64-a.dtb /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb
# fdtput -t s -v /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb /usb@fd000000 status disabled
# fdtput -t s -v /boot/dtbs/rockchip/rk3566-quartz64-a-sata.dtb /sata@fc400000 status okay
# sed -i 's#^FDT /dtbs/rockchip/rk3566-quartz64-a.dtb$#FDT /dtbs/rockchip/rk3566-quartz64-a-sata.dtb#' /boot/extlinux/extlinux.conf
# systemctl reboot

[[Category:Quartz64]]

Quartz64 Development

2022-10-14T18:56:37Z

CameronNemo: /* Upstreaming Status */ Update CSI DPHY 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" rowspan="3" | Bootloader
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952]
| <code>TF-A</code>
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress
| <code>U-Boot</code>
| [[Quartz64_Development#Mainline_U-Boot_Work|See below]]
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress[https://github.com/jaredmcneill/quartz64_uefi]
| <code>Tianocore EDK II</code>
|
|-
! 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 Mainline
| <code>rockchip-inno-csidphy</code>
| As of 6.1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=29c99fb085ad53e6d5504d1f8d32e6673b9b3a2c]
|
|-
! 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]]

Quartz64 Development

2022-10-14T15:24:00Z

CameronNemo: /* Upstreaming Status */ Update u-boot / bootloader 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" rowspan="3" | Bootloader
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952]
| <code>TF-A</code>
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress
| <code>U-Boot</code>
| [[Quartz64_Development#Mainline_U-Boot_Work|See below]]
|
|-
| colspan="2" style="background:LightYellow; text-align:center;"|In progress[https://github.com/jaredmcneill/quartz64_uefi]
| <code>Tianocore EDK II</code>
|
|-
! 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

2022-09-21T18:17:53Z

CameronNemo: /* Post NVMe install power limiting */ formatting

= User Guide =
== Introducing PineBook Pro ==
[[File:PBP.jpg|400px|thumb|right|Pinebook Pro running Debian with MATE]]

The Pinebook Pro is a Linux and *BSD ARM laptop from [https://www.pine64.org/ PINE64]

It is built to be a compelling alternative to mid-ranged Chromebooks that people convert into Linux laptops. It features an IPS 1080p 14″ LCD panel, a premium magnesium alloy shell, high capacity eMMC storage, a 10,000 mAh capacity battery, and the modularity that only an open source project can deliver.

It's compact and slim dimensions are 329mm x 220mm x 12mm (WxDxH).

Key features include: the RK3399 SOC; USB-C for data, video-out and power-in (3A 5V); privacy switches for the microphone, BT/WiFi module, and camera; and expandable storage via NVMe (PCIe x4) with an optional adapter.

The Pinebook Pro is equipped with 4GB LPDDR4 system memory, high capacity eMMC flash storage, and 128Mb SPI boot Flash. The I/O includes: 1 x micro SD card reader (bootable), 1 x USB 2.0, 1 x USB 3.0, 1 x USB type C Host with DP 1.2 and power-in, PCIe x4 for an NVMe SSD drive (requires an optional adapter), and UART (via the headphone jack by setting an internal switch).

The keyboard and touchpad both use the USB 2.0 protocol. The LCD panel uses eDP MiPi display protocol.

Many different Operating Systems (OS) are freely available from the open source community and partner projects. These include various flavors of Linux (Ubuntu, Debian, Manjaro, etc.) and *BSD.

== Software and OS Image Downloads ==

=== Default Manjaro KDE Desktop Quick Start ===

When you first get your Pinebook Pro and boot it up for the first time, it'll come with Manjaro using the KDE desktop. The Pinebook Pro is officially supported by the Manjaro ARM project, and support can be found on the [https://forum.manjaro.org/c/manjaro-arm/78 Manjaro ARM forums.]

On first boot, it will ask for certain information such as your timezone location, keyboard layout, username, password, and hostname. Most of these should be self-explanatory. Note that the hostname it asks for should be thought of as the "codename" of your machine, and if you don't know what it's about, you can make something up (use a single word, all lower case, no punctuation; e.g. "pbpro").

After you're on the desktop, be sure to update it as soon as possible and reboot after updates are finished installing. If nothing appears when you click on the Networking icon in your system tray to connect to your Wi-Fi, ensure the Wi-Fi [https://wiki.pine64.org/index.php/Pinebook_Pro#ANSI_Fn_.2B_F_keys_wrong_for_F9.2C_F10.2C_F11_and_F12 privacy switch] is not disabled.

=== Pinebook Pro images ===
Under [[Pinebook Pro Software Release]] you will find a complete list of currently supported Operating System images that work with the Pinebook as well as other related software.

The list includes OS images and descriptions of:

* [[PinebookPro_Software_Release#Manjaro ARM|Manjaro ARM]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Armbian|Armbian]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Twister OS|Twister OS]] (microSD Boot)
* [[PinebookPro_Software_Release#Fedora|Fedora]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Arch_Linux_ARM|Arch Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#postmarketOS|Postmarket OS]] (microSD and USB boot)
* [[PinebookPro_Software_Release#Kali Linux|Kali Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#DietPi|DietPi]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Q4OS|Q4OS]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#NetBSD|NetBSD]] (microSD and eMMC Boot)
* [[Pinebook_Pro_Software_Release#OpenBSD|OpenBSD release for ARM64]]
* [[Pinebook_Pro_Software_Release#Gentoo|Gentoo]]
* [[Pinebook_Pro_Software_Release#Slackware|Slackware (microSD boot)]]
* [[Pinebook_Pro_Software_Release#Void_Linux|Void Linux]]

== Keyboard ==
The Pinebook Pro is available in two keyboard configurations: ISO and ANSI. Both the keyboard and touchpad in the Pinebook Pro use the USB 2.0 protocol and show up as such in xinput. The keyboard features function (Fn) keys in the F-key row, which include display brightness controls, sound volume, touchpad lock, and other functionality. There is also a custom PINE64 logo key that functions as Menu/Super key. It has also a secondary functionality for setting the privacy switches.

The keyboard firmware binary can be flashed from userspace using the provided open source utility.

{{warning|DO NOT update the keyboard firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed, see the [https://reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Documentation for the keyboard can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]].

=== Typing special characters ===
The [[Wikipedia:British_and_American_keyboards#Other_keyboard_layouts|UK ISO Layout]] does not have dedicated keys for characters like the German umlauts (Ä,Ö,Ü, etc). Certain characters can still be generated by means of either key combinations or key sequences.
{| class="wikitable"
!Character
!Key combination/sequence
|-
|Ä, Ö, Ü, ä, ö, ü
|[[Wikipedia:AltGr_key|[AltGr]]]+'[' followed by [A], [O], [U], [a], [o] or [u]
|-
|µ
|[AltGr]+[m]
|-
|Ø, ø
|[AltGr]+[O], [AltGr]+[o]
|-
|@
|[AltGr]+[q] (as on the German layout)
|-
|ß
|[AltGr]+[s]
|-
|§
|[AltGr]+[S]
|-
|°
|[AltGr]+[)]
|}

=== Privacy Switches ===
There are three privacy switches mapped to the F10, F11 and F12 keys on the Pinebook Pro keyboard. They de/activate the following:

{| class="wikitable"
|+ Privacy switch function and description
! Combination
! Effect
! Description
! Notes
|-
! scope=row | PINE64 logo key+F10
| Microphone Privacy switch
| CAPs lock LED blinks. 2 blinks = enabled, 3 blinks = disabled
|-
! scope=row | PINE64 logo key+F11
| WiFi Privacy switch
| NUM lock LED blinks. 2 blinks = WiFi enabled / privacy switch disabled, 3 blinks = WiFi disabled / privacy switch enabled.
| '''Re-enabling requires reboot''' (or a [//forum.pine64.org/showthread.php?tid=8313&pid=52645#pid52645 command line hack to bind/unbind]).
|-
! scope=row | PINE64 logo key+F12
| Camera privacy switch
| CAPs lock and NUM lock LEDs blink together. 2 blinks = enabled, 3 blinks = disabled
| Can use tools like '''<code>lsusb</code>''' to detect camera's presence. If not detected, check privacy switch.
|}

'''(Press the PINE64 logo key plus F10/F11/F12) for 3 seconds)'''

The keyboard operates on firmware independent of the operating system. It detects if one of the F10, F11 or F12 keys is pressed in combination with the Pine key for 3 seconds. Doing so disables power to the appropriate peripheral, thereby disabling it. This has the same effect as cutting off the power to each peripheral with a physical switch. This implementation is very secure, since the firmware that determines whether a peripheral gets power is not part of the Pinebook Pro’s operating system. So the power state value for each peripheral cannot be overridden or accessed from the operating system. The power state setting for each peripheral is stored across reboots inside the keyboard's firmware flash memory.

=== Basic summary of replacing keyboard ===

This guide is very basic and should be fleshed out with (better) pictures. There just isn't a list of steps anywhere else yet.

Here's what the replacement keyboard looks like:

[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (front)]]
[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (back)]]

''Step 0'': If changing from ISO keyboard to ANSI keyboard, or vice versa, be sure to have a system capable of running the firmware updater that you can access either remotely or with a USB keyboard beyond the internal keyboard, as the firmware for each is very different and keys won't work correctly. See https://forum.pine64.org/showthread.php?tid=8407 (and for NetBSD, https://forum.pine64.org/showthread.php?tid=8716).

''Step 1'': The remove back back panel.

There are 10 screws on the back that must be removed, and the back panel detached. I recommend using a PH0 bit. The speakers may remain attached via glue to the case and should be carefully pried off. When this is done, taking photos of how everything looks now can help put it all back together later.

[[File:Pinebook_Pro_keyboard-replacement-screws.jpg|300px|Remove the back panel]]

''Step 2'': Places to unscrew.

There are 3 items screwed into the keyboard frame that must be removed. There are 2 large screws for daughter board, 3 large screws and 1 small screw for mainboard, and 4 small screws for battery. Be sure to not lose them. I recommend a PH00 bit for the large screws on the daughter and main boards and a PH1 bit for the small screws on the battery and mainboard.

[[File:Pinebook_Pro_new_keyboard-back-removed.jpg|300px|Remove the back panel]]

''Step 3'': Remove the battery.

Once the battery screws are removed, it should be unplugged from the mainboard and removed. Note that there are two unconnected cables lying around, that should remain unconnected. They are used when the battery is disconnected entirely.

[[File:Pinebook_Pro_new_keyboard-zoom-mainboard.jpg.jpg|300px|Zoom on the mainboard]]
[[File:Pinebook_Pro_new_keyboard-zoom-daughterboard.jpg|300px|Zoom on the daughterboard]]

''Step 4'': Unplug the ribbon cables.

NOTE: you should remove the M.2 adapter board now if you have one installed. See elsewhere in this wiki for instructions on how to install/remove that piece.

There are several ribbon cables. To remove, flip up the tab and gentle pull the ribbon out.

* One cable runs from the mainboard to the daughterboard underneath the battery. Detach from both ends. With the battery removed, detach from keyboard shell, and set aside for the new keyboard shell.
* One cable runs between the touchpad and the mainboard. Detach from both ends, and also set aside.
* One cable runs between the keyboard and the mainboard. This one remains attached to the keyboard and only needs to be detached from the mainboard.
* One cable from the LCD attaches near the lid hinge. It should be just unplugged.

''Step 5'': Detach microphone, speakers, and antenna.

[[File:Pinebook_Pro_microphone_removed.jpg|300px|thumb|right|One of the Pinebook Pro microphones after removal]]

The speakers, microphone, and antenna don't have to be detached from the mainboard, but they need to be detached from the keyboard shell. The microphones are held in place by tape, and the speakers have sticky sides. The speakers are found obviously, but the microphones (two of) can be found between the battery and the hinge area. Each microphone can be carefully pulled/wedged out of its position by a small screwdriver or pick. The antenna, similar to the microphones, is found near the hinge area and to the top left of the battery.

''Step 6'': Remove mainboard and daughterboard.

At this point, the mainboard and daughterboards should be removed. When unscrewed (see Step 2) they should pull out fairly easily. Put them aside (including microphones and speakers if left attached.)

[[File:Pinebook_Pro_new_keyboard-all-boards-removed.jpg|300px|All boards removed]]

''Step 7'': Detach the LCD panel.

Step 2 didn't tell you, there are 6 more screws to remove here, 3 for each of the hinges. I recommend a PH1 bit for these screws. Unscrew these and the LCD panel will be able to be removed. You may have to jiggle or move the hinges for this. When detached, be sure to place the LCD panel such that the display is protected.

[[File:Pinebook_Pro_new_keyboard-detached-display.jpg|300px|Display detached]]
[[File:Pinebook_Pro_new_keyboard-detached-display2.jpg|300px|Display detached (front)]]

''Step 8'': Try Not To Break Your Touchpad, or, How I Learned To Love Things That Bend

'''NOTE This section really feels like you're going to break something.'''

The touchpad is glued to the keyboard shell and it's glued well. There are two places it is glued to. If you can, only the middle must be force-detached. You will think you're going to break it. Gently apply increasing force until the glue begins to detach (you will hear a crackle as it comes off), and continue very slowly until the whole thing is detached. This may take minutes due to that feeling you're going to break it.

I found it helpful to lift the top left plastic bit on the keyboard to unstick that portion of the touchpad, then push on the top left portion of the touchpad to unstick the rest of the touchpad.

[[File:Pinebook_Pro_new_keyboard-touchpad1.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad2.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad3.jpg|300px|Unmouting the touchpad]]

''Step 9'': Over the hill, touchpad goes into new shell.

In the new keyboard shell put the touchpad back where it was, hopefully the glue will remain sufficiently attached. If there is a glue issue, this guide unfortunately has no advice currently.

[[File:Pinebook_Pro_new_keyboard-install-touchpad.jpg|300px|Install the touchpad]]

''Step 10'': Reattach the LCD panel.

The LCD panel should slot back into the keyboard frame, the same way it came out. If the hinges were moved, they should be *very* *gently* closed such that the LCD panel and keyboard closed like normal for the remaining steps.

''Step 11'': Tape it out.

Move any tape from the old keyboard shell to the new one. These items protect the mainboard and daughterboard, and keep various wires in their right place. Some are grey and some are black. For tape that holds the speakers, microhones, or their cables in place, do not reattach yet.

''Step 12'': Board install.

Install the mainboard, the daughtboard, and their connecting ribbon cable. Be sure to put the boards in place, 2 large flat screws for the daughterboard, 3 large flat screws and one small screw for the mainboard, before attempting to place the ribbon.

''Step 13'': Microphone, speaker, and antenna install.

Reattach the microphones, antenna, and speakers to their respective areas, making sure that both are properly oriented - the speaker "out" faces up, and the microphone cables as connected must face up (these are opposite directions.)

''Step 14'': Reattach other ribbon cables.

NOTE: this would be a good time to attach/install the M.2 adapter board if that is desired. See elsewhere in this wiki for those instructions.

The LCD panel, keyboard and touchpad ribbon cables should be reattached. Make sure the flap is open, insert the ribbon into the slot (a portion of the cable will disappear), and push the flap down. The cable should not be easy to pull out.

''Step 15'': Reattach the battery, and final re-tape.

The battery should be installed with the 4 screws holding it in place, and the connector attached to the mainboard. Be sure to keep the two other cables remain unconnected. Ensure all wires and other tapes are held in place.

''Step 16'': Reattach the back panel.

Put the back panel back on, and reattach the 10 screws.

''Step 17'': If you changed from ISO to ANSI or from ANSI to ISO, you'll need to update your firmware now. See the links in Step 0 above.

== Touchpad (trackpad) ==
Documentation for the touchpad can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]]. It is the only component of the Pinebook Pro held in place with strong adhesive tape. Here are some of its features:

* 2 actuating buttons.

* multi-touch functionality.

* A matte finish that your finger can slide along easily.

* A reasonable size (96mm × 64mm; diagonal: 115.378mm or 4.542”).

=== Troubleshooting ===

If you are having trouble using 2 fingers to scroll or emulate the click of a mouse's right-button, then try these solutions:

* Update the firmware.

* Keep your 2 fingers spread apart rather than close together.

* Individual programs might need to be configured specially.

:* For smooth scrolling and gestures under X-Windows, ''Firefox'' should be launched with with the following environment variable assignment:

::: <code>MOZ_USE_XINPUT2=1</code>

* Experiment with other settings, via [[#X-Windows Configuration|X-Windows Configuration]] or some other system preferences; for example, you could disable double-finger scrolling, and instead enable scrolling by sliding one finger along the edge of the touchpad.

=== Firmware ===
The touchpad controller is connected to the keyboard controller. All touchpad events go through the keyboard controller and it's software, then to the keyboard controller's USB port. Note that the touchpad does have separate firmware, (which has to be written through the keyboard controller). The touchpad vendor’s firmware binary can be flashed from userspace using the following open source command-line utility:

* Kamil Trzciński’s [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater pinebook-pro-keyboard-updater].

Naturally, forks have begun to appear:

* Jack Humbert’s [https://github.com/jackhumbert/pinebook-pro-keyboard-updater fork]

* Dragan Simic’s [https://github.com/dragan-simic/pinebook-pro-keyboard-updater fork]. This one has recently delivered a much improved firmware from the vendor, which greatly improves the control of the cursor (see this [https://forum.pine64.org/showthread.php?tid=14531 thread] for discussion); before installing this update, consider resetting to the defaults any configuration of your touchpad.

'''Every Pinebook Pro produced before September 2021 should have its keyboard and touchpad firmware updated.'''

{{warning| DO NOT update the touchpad firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed. See [//old.reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Before updating ''any'' firmware, your Pinebook Pro should be either fully charged or, preferably, running from mains. This utility will be writing data to chips on the keyboard and touchpad, so a loss of power during any stage of the update can result in irrecoverable damage to your touchpad or keyboard.

The scripts ought to work on all OSs available for the Pinebook Pro. Some OSs may, however, require installation of relevant dependencies. The instructions below assume a Debian desktop. To install these dependencies, newer Pinebook Pro models that come with Manjaro will require a different command.

There are two keyboard versions of the Pinebook Pro: ISO and ANSI. You need to know which model you have prior to running the updater.
Firmware update steps for both models are listed below.

What you will need:

* Connection to WiFi (for getting dependencies).

* Your Pinebook Pro fully charged or running from mains power.

* An external USB keyboard & mouse (or access to the Pinebook Pro via SSH. Please note that for some configurations, the SSH service might not be available without first having logged in once; in this case, you will definitely want at least an external keyboard).

==== ISO Model ====

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 iso
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 iso
sudo poweroff # do not use 'reboot'
</pre>

==== ANSI Model ====

{{Hint| Note: Running step 1 on the ANSI keyboard model will make the keyboard and touchpad inaccessible until step 2 is run, so an external keyboard must be connected to complete the update on this model!}}

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 ansi
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 ansi
sudo poweroff # do not use 'reboot'
</pre>

When done, if some of the keys produce incorrect characters, please check your OS’s language settings. For ANSI users, the default OS may have shipped with English UK as the default language; you can change it to English US if desired.

==== Revised Firmware ====

In addition, you might consider using revised firmware data; this is one final step that should not require a reboot:

Step 3: '''ISO''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_iso.hex
</pre>

Step 3: '''ANSI''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_ansi.hex
</pre>

=== X-Windows Configuration ===
''Before making adjustments, consider updating the firmware; reset your adjustments before updating the firmware, so that your adjustments do not interfere with new functionality.''

Some forum members have found that an adjustment to X-Windows will allow finer motion in the touchpad. If you use the '''Synaptic''' mouse/touchpad driver, use this command to make the change live:
<pre>synclient MinSpeed=0.25</pre>
You may experiment with different settings, but 0.25 was tested as helping noticeably. 
 
To make the change persist across reboots, change the file <code>/etc/X11/xorg.conf</code> similar to below:
<pre> Section "InputClass"
Identifier "touchpad catchall"
Driver "synaptics"
MatchIsTouchpad "on"
MatchDevicePath "/dev/input/event*"
Option "MinSpeed" "0.25"
EndSection</pre>
The line <code>Option "MinSpeed" "0.25"</code> is the change. 
 
Another forum user built on the above settings a little, and have found these to be very good:
<pre>synclient MinSpeed=0.25
synclient TapButton1=1
synclient TapButton2=3
synclient TapButton3=2
synclient FingerLow=30
synclient PalmDetect=1
synclient VertScrollDelta=64
synclient HorizScrollDelta=64</pre>

<code>FingerLow</code> has the same value as 'FingerHigh' in one config (30). It is believed to help reduce mouse movement as you lift your finger, but it's unknown whether synaptic works like this.
You may find this config to be comfortable for daily use.
 

<code>TabButton</code> allows to just tab the touchpad instead of physically pressing it down (to get this click noise).

The <code>right mouse click</code> is emulated by tapping with two fingers on the touchpad. If you feel that this is not very responsive you can try this value:
<pre> synclient MaxTapTime=250 </pre>

Some users may encounter an issue with the mouse jumping when typing when using libinput driver (has not been test with synaptic) due to their hand hitting the touchpad which can be fixed by updating the xorg settings to disable it while typing. One can disable the touchpad while typing by setting the below option in the xorg config simliar to the previou example.

<pre>
Option "DisableWhileTyping" "on"
</pre>

The setting can be verified by using the xinput command to first list the devices and then listing the properties for the Touchpad device. Exact commands to check this have been omitted for save of brevity. If DisableWhileTyping is shown enabled but does not appear to be working the issue may be due to the fact that the keyboard is connected to a USB bus which causes it to be seen as a external keyboard. To resolve this one can add the config below which sets the keyboard to internal to ensure the DisableWhileTyping works properly.

You will need to edit <code>/etc/libinput/local-overrides.quirks</code> and add the following lines:
<pre>
[Serial Keyboards]
MatchUdevType=keyboard
MatchBus=usb
AttrKeyboardIntegration=internal
</pre>

Once X11 is restarted the new setting should now take effect and you will no longer be able to use the touchpad while typing which will mostly eliminate the mouse jumping issue.

== Power Supply ==
* Input Power: 5V DC @ 3A
* Mechanical: 3.5mm OD / 1.35mm ID, Barrel jack
* USB-C 5V, 15W PD quickcharge
* Only use one power input at a time, barrel jack OR USB-C

== LEDs ==
In total, there are four LEDs on the Pinebook Pro, three of which are placed in the top-left side of the keyboard, and one near the barrel port:

# The red LED next to the barrel port indicates charging, in three ways. First, it will illuminate steadily when either the factory power supply or a USB Type-C charger is connected to the Pinebook Pro, and the battery is getting charged. Second, if the battery is at 100%, the LED will remain turned off regardless of the connected power input; however, this is [https://forum.pine64.org/showthread.php?tid=10899 rather rarely achieved]. Third, this LED will flash at 0.5 Hz if there are any problems that prevent charging, such as the battery becoming too hot.
# The power indicator LED, above the keyboard, supports three different colors: green, amber and red. It is also capable of flashing to indicate eMMC activity. In the default Debian with MATE build, green LED means power and red means suspend (amber is unused).
# The green NumLock LED, above the keyboard.
# The green CapsLock LED, above the keyboard.

The NumLock and CapsLock LEDs serve their usual purposes on a keyboard, but they also have a secondary function. When the privacy switches get activated they blink to confirm that the switch has been activated.

== Webcam ==
{{Hint| You can use Cheese to test the Camera functionality}}
* Streaming video resolutions supported, (uncompressed):
** 320 x 240
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Still frame resolutions supported:
** 160 x 120
** 176 x 144
** 320 x 240
** 352 x 288
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200

== Microphones ==
While it has been said that some Pinebook Pro units contain only one microphone despite having two labeled microphone holes on the outer casing, other units do indeed contain two microphones. It is presently unclear which batches have either configuration; units from the initial community batch of 1000 units (following the initial 100) are believed to contain two, populating both labeled holes.

The wires leading to both microphones connect to the mainboard with a small white plastic connector, located directly adjacent to the ribbon cable attachment point for the keyboard interface.

'''Microphones not working?'''

If pavucontrol input doesn't show microphone activity try changing the [[Pinebook_Pro#Privacy_Switches|privacy switches]]. If the switches are in the correct place and microphone input isn't working you can run <code>alsamixer</code> from the command line, hit F6 and select the es8316, hit F4 to get to the capture screen, select the bar labeled ADC, increase the gain to 0dB, change the audio profile in pavucontrol to another one with input. Additionally you may want to modify ADC PGA to get the levels to where you want them. If that still hasn't fixed it you may want to check that the microphone connector is plugged in (see the section [[#Technical Reference|Technical Reference]]).

== Bluetooth and WiFi ==
[[File:PinebookPro_WirelessIC_Location.jpg|400px|thumb|right|The Pinebook Pro's AP6256 wireless module]]
===Hardware Overview===
The Pinebook Pro contains an AMPAK AP6256 wireless module to provide Wi-Fi (compliant to IEEE 802.11ac) and Bluetooth (compliant to Bluetooth SIG revision 5.0). The module contains a Broadcom transceiver IC, believed to be the BCM43456, as well as the support electronics needed to allow the Wi-Fi and Bluetooth modes to share a single antenna.

The wireless module interfaces with the Pinebook Pro’s system-on-chip using a combination of three interfaces: Bluetooth functionality is operated by serial UART and PCM, while the Wi-Fi component uses SDIO. It is unknown if the module’s Bluetooth capabilities are usable under operating systems that do not support SDIO.

The module’s RF antenna pin is exposed on the mainboard via a standard Hirose U.FL connector, where a coaxial feedline links it to a flexible adhesive antenna situated near the upper right corner of the Pinebook Pro’s battery. As the RF connector is fragile and easily damaged, it should be handled carefully during connection and disconnection, and should not be reconnected frequently.

===Issues===
Problems have been reported with the Wi-Fi transceiver’s reliability during extended periods of high throughput, especially on the 2.4 GHz band. While the cause of this has yet to be determined, switching to the 5 GHz band may improve stability.

Since the Bluetooth transceiver shares both its spectrum and antenna with 2.4 GHz Wi-Fi, simultaneous use of these modes may cause interference, especially when listening to audio over Bluetooth. If Bluetooth audio cuts out frequently, switching to the 5 GHz band – or deactivating Wi-Fi – may help.

===Wi-Fi Capabilities===
Wi-Fi on the Pinebook Pro is capable of reaching a maximum data transfer rate of approximately 433 megabits per second, using one spatial stream. The transceiver does not support multiple spatial streams or 160-MHz channel bandwidths.

The Wi-Fi transceiver supports the lower thirteen standard channels on the 2.4 GHz band, using a bandwidth of 20 MHz. At least twenty-four channels are supported on the 5 GHz band, spanning frequencies from 5180 to 5320 MHz, 5500 to 5720 MHz, and 5745 to 5825 MHz, with bandwidths of 20, 40, or 80 MHz.

Maximum reception sensitivity for both bands is approximately -92 dBm. The receiver can tolerate input intensities of no more than -20 dBm on the 2.4 GHz band, and no more than -30 dBm on the 5 GHz band. Maximum transmission power is approximately +15 dBm for either band, falling further to approximately +10 dBm at higher data transfer rates on the 5 GHz band.

With current available drivers and firmware, the Wi-Fi interface supports infrastructure, ad-hoc, and access-point modes with satisfactory reliability. Monitor mode is not presently supported. Wi-Fi Direct features may be available, but it is unclear how to make use of them under Linux.

Be aware that Linux userspace utilities, such as <code>iw</code>, may report inaccurate information about the capabilities of wireless devices. Parameter values derived from vendor datasheets, or direct testing, should be preferred to the outputs of hardware-querying tools.

===Bluetooth Capabilities===
Bluetooth data transfer speeds have an indicated maximum of 3 megabits per second, but it is unclear what practical data rates can be expected. Audio streaming over Bluetooth is functioning normally, as is networking. Bluetooth Low-Energy functions, such as interacting with Bluetooth beacons, have not yet been tested conclusively.

The Bluetooth transceiver supports all 79 channel allocations, spanning frequencies from 2402 MHz to 2480 MHz. Reception sensitivity is approximately -85 dBm, with a maximum tolerable reception intensity of -20 dBm. Bluetooth transmission power is limited to +10 dBm.

===Disabling Bluetooth===

To disable Bluetooth under Linux once:

sudo rfkill block bluetooth

To confirm if Bluetooth under Linux is disabled:

rfkill

To disable Bluetooth on boot (note: for distributions such as Manjaro XFCE see the step below):

sudo systemctl enable rfkill-block@bluetooth

To disable Bluetooth on certain distributions, such as Manjaro XFCE, right click on the Bluetooth panel icon, select plugins, then PowerManager, then configuration and then deselect the auto power on option

== LCD Panel ==
* Model: BOE NV140FHM-N49
* 14.0" (35.56 cm) diagonal size
* 1920x1080 resolution
* 60 Hz refresh rate
* IPS technology
* 1000:1 contrast
* 250 nit brightness
* 63% sRGB coverage
* 6-bit color
* 30-pin eDP connection

Some people have tested hardware video decode using the following;

<pre>ffmpeg -benchmark -c:v h264_rkmpp -i file.mp4 -f null -</pre>

== External ports list ==
Here are a list of the external ports. See [[Pinebook_Pro#Expansion_Ports|Technical Reference - Expansion Ports]] for port specifications.
* Left side
** Barrel jack for power, (with LED)
** USB 3, Type A
** USB 3, Type C
* Right side
** USB 2, Type A
** Standard headset jack
** MicroSD card slot

== Using the UART ==
[[File:PinePhone_Serial_Cable.png|400px|thumb|right|Pinout of the serial adapter. Swapping the tx and rx around from this also works and is more traditional. See the official [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pine64 document].]]

UART output is enabled by flipping the UART switch to the ON position (item 9). To do so you need to remove the Pinebook Pro's bottom cover - please follow [[Pinebook_Pro#Disassembly_and_Reassembly|proper disassembly and reassembly protocol]]. The OFF position is towards the touchpad, the ON position is towards the display hinges.

With the UART switch in the ON position, console is relayed via the audiojack and the laptop's sound is turned OFF. Please ensure that you are using a 3.3 V interface (such as the CH340, FTDI-232R, or PL2303, which are sold in both 3.3 V and 5 V variants) to avoid damage to the CPU. Older version of the serial console cable sold by Pine64 uses wrong voltage level and should not be used; see [https://forum.pine64.org/showthread.php?tid=9367 this forum thread] for further information. Recent version of the same cable uses the right voltage level.

Insert the USB plug of the cable into an open USB port on the machine which will monitor, ensuring that the audio jack of the serial cable is be fully inserted into the Pinebook Pro audio port. Run the following in a terminal:

<code>
$ lsusb
</code>

you should find a line similar to this:

<code>
Bus 001 Device 058: ID 1a86:7523 QinHeng Electronics HL-340 USB-Serial adapter
</code>

Serial output should now be accessible using screen, picocom or minicom (and others).
Examples:

<code>
screen /dev/ttyUSB0 1500000

picocom /dev/ttyUSB0 -b 1500000

minicom -D /dev/ttyUSB0 -b 1500000</code>

Old versions of U-Boot do not use the UART for console output. <strike>The console function is activated by the Linux kernel. Thus, if you use a non-Pinebook Pro Linux distro and want the UART as a console, you have to manually enable it.</strike>

== Using the optional NVMe adapter ==
The optional NVMe adapter allows the use of M.2 cards that support the NVMe standard, (but not SATA standard). The optional NVMe M.2 adapter supports '''M''' & '''M'''+'''B''' keyed devices, in both 2242 & 2280 physical sizes, the most common ones available. In addition, 2230 & 2260 are also supported, though NVMe devices that use those sizes are rare.

Once you have fitted and tested your NVMe drive, please add a note to this page [[Pinebook Pro Hardware Accessory Compatibility]] to help build a list of tried and tested devices.

Please see [[Pinebook Pro Troubleshooting Guide#NVMe SSD issues|a separate section]] that describes reported issues with the NVMe drives in PineBook Pro.

=== Installing the adapter ===
The V2.1-2019-0809 SSD adapter that shipped with the initial Pinebook Pro batches had significant issues. A repair kit will be shipped to address those issues.
(If necessary, it can be modified to work. There is [https://forum.pine64.org/showthread.php?tid=8322&pid=52700#pid52700 an unofficial tutorial on the forums] describing these modifications.)

The updated SSD adapter, labeled V2-2019-1107, takes into account the prior problems with touchpad interference. New orders as of Feb. 22nd, 2020 will be the updated adapter.

This is the link to the Pinebook Pro accessories in the store: [[https://pine64.com/?v=0446c16e2e66]]

Actual installation instructions are a work in progress. Unofficial instructions for installing V2-2019-1107 can be found [https://eli.gladman.cc/blog/2020/06/23/pine-book-pro-nvme.html here].

=== Post NVMe install power limiting ===
Some NVMe SSDs allow reducing the maximum amount of power. Doing so may reduce the speed, but it may be needed in the Pinebook Pro to both improve reliability on battery: Some NVME may be stable with default settings when runnning on AC power but cause frequent kernel panics (system freeze with power LED blinking red/green) when running on battery. Reducing NVME power drain solves this in some cases. And reducing power used gives better battery life.
Here are the commands to obtain and change the power settings. The package 'nvme-cli' is required to run these commands. The example shows how to find the available power states, and then sets it to the lowest, non-standby setting, (which is 3.8 watts for the device shown);

<pre>$ sudo nvme id-ctrl /dev/nvme0
NVME Identify Controller:
...
ps 0 : mp:9.00W operational enlat:0 exlat:0 rrt:0 rrl:0
rwt:0 rwl:0 idle_power:- active_power:-
ps 1 : mp:4.60W operational enlat:0 exlat:0 rrt:1 rrl:1
rwt:1 rwl:1 idle_power:- active_power:-
ps 2 : mp:3.80W operational enlat:0 exlat:0 rrt:2 rrl:2
rwt:2 rwl:2 idle_power:- active_power:-
ps 3 : mp:0.0450W non-operational enlat:2000 exlat:2000 rrt:3 rrl:3
rwt:3 rwl:3 idle_power:- active_power:-
ps 4 : mp:0.0040W non-operational enlat:6000 exlat:8000 rrt:4 rrl:4
rwt:4 rwl:4 idle_power:- active_power:-

$ sudo nvme get-feature /dev/nvme0 -f 2
get-feature:0x2 (Power Management), Current value:00000000
$ sudo nvme set-feature /dev/nvme0 -f 2 -v 2 -s
set-feature:02 (Power Management), value:0x000002</pre>

Some NVMe SSDs don't appear to allow saving the setting with "-s" option. In those cases, leave off the "-s" and use a startup script to set the non-default power state at boot. 
If you want to test performance without saving the new power setting semi-permanantly, then leave off the "-s" option.

On systemd based distros like Manjaro, a non-defaut power state for an NVME can be set using a systemd service. 
This is useful in cases where the NVME drive does not save the power state and/or uses APST. 
An example systemd service, nvme-throttle.service, is shown below:

<pre>
[Unit]
Description=Throttles NVME to lesss power hungry mode
After=suspend.target hibernate.target hybrid-sleep.target suspend-then-hibernate.target

[Service]
Type=oneshot
ExecStart=/usr/bin/nvme set-feature /dev/nvme0 -f 2 -v 1

[Install]
WantedBy=multi-user.target suspend.target hibernate.target hybrid-sleep.target suspend-then-hibernate.target
</pre>

Here the value after "-v" is the maximum power state that you want your SSD to use. 
This will be executed at system startup, and every time your system exits any suspend mode that might reset the SSD to default values.

This file needs to be placed in the /etc/systemd/system directory. Afterwards, to activate the service, run:

<pre>
systemctl daemon-reload
systemctl enable --now nvme-throttle.service
</pre>

There is another power saving feature for NVMes, APST, (Autonomous Power State Transitions). This performs the power saving & transitions based on usage. To check if you have a NVMe SSD with this feature;
<pre>$ sudo nvme get-feature -f 0x0c -H /dev/nvme0</pre>
Information for this feature, (on a Pinebook Pro), is a work in progress. It is enabled by default in latest Manjaro kernels and reported to work.
On some NVME SSDS (WD), APST is compatible with limiting NVME maximum power : APST will work and not exceed maximum power state defined using
previous method.

=== Using as data drive ===
As long as the kernel in use has both the PCIe and NVMe drivers, you should be able to use a NVMe drive as a data drive. It can automatically mount when booting from either the eMMC or an SD card. This applies to Linux, FreeBSD, and Chromium, using the normal partitioning and file system creation tools. Android requires testing.

=== Using as OS root drive ===
The SoC does not include the NVMe boot code, so the NVMe is not in the SoC's boot order. However, using the [https://github.com/mrfixit2001/updates_repo/blob/v1.1/pinebook/filesystem/mrfixit_update.sh U-Boot update script] from the mrfixit2001 Debian or [https://pastebin.com/raw/EeK074XB Arglebargle's modified script], and [https://github.com/pcm720/rockchip-u-boot/releases the modified u-boot images] provided by forum user pcm720, you can now add support to boot from an NVMe drive. Binary images are useable with SD, eMMC, and [[Pinebook_Pro_SPI|SPI flash]]. For OS images using the mainline kernel, there are a few variants of U-Boot available that also support NVMe as the OS drive. Though these may require writing the U-Boot to the SPI flash for proper use of the NVMe as the OS drive.

The current boot order, per last testing, for this modified U-Boot is:
*MicroSD
*eMMC
*NVMe

For more information, please refer to [https://forum.pine64.org/showthread.php?tid=8439&pid=53764#pid53764 the forum post.]

It is also possible to initially boot off an eMMC or SD card, then transfer to a root file system on the NVMe. Currently, it is necessary to have the U-Boot code on an eMMC or SD card. (A forum member [https://forum.pine64.org/showthread.php?tid=8439 posted here] about using a modified version of U-Boot with NVMe drivers, that uses <code>/boot</code> and <code>/</code> off the NVMe drive. So this may change in the future.)

Please see [[Pinebook_Pro#Bootable Storage|Bootable Storage]].

== Caring for the PineBook Pro ==
=== Bypass Cables ===
The mainboard features two (disconnected by default) bypass cables that are only to be used with the battery disconnected. The female (10) male (6) ends of the bypass cables can be connected to provide power to the mainboard if you need to run the laptop without a battery. Please refer to this [https://files.pine64.org/doc/PinebookPro/PinebookPro_Engineering_Notice.pdf engineering notice].

'''Note that despite the bypass cable being a two conductor cable, it is only used as one. Both wires being soldered together on either side is normal!'''

{{warning|Do not connect the bypass cables with the battery connected. Using the bypass cables with the battery connected can permanently damage the computer.}}

=== Pinebook Service Step-by-Step Guides ===

Under [[Pinebook_Service_Step_by_Step_Guides|Service Guides for Pinebook]] you can find instructions guides concerning disassembly of:

* The installation process on Pinebook Pro similar to 14" Pinebook
* The installation process is the reverse order of removal guide:
** 14″ Pinebook Lithium Battery Pack Removal Guide
** 14″ Pinebook LCD Panel Screen Removal Guide
** 14″ Pinebook eMMC Module Removal Guide

== Using the SPI flash device ==

See [[Pinebook Pro SPI]] for details.

The Pinebook Pro comes with a 128Mbit, (16MByte), flash device suitable for initial boot target, to store the bootloader. The SoC used on the Pinebook Pro boots from this SPI flash device first, before eMMC or SD card. At present, April 19, 2020, the Pinebook Pros ship without anything programmed in the SPI flash device. So the SoC moves on to the next potential boot device, the eMMC. ARM/ARM64 computers do not have a standardized BIOS, yet.

Here is some information on using the SPI flash device:

* You need the kernel built with SPI flash device support, which will supply a device similar to: code>/dev/mtd0</code>
* The Linux package below, will need to be available: <code>mtd-utils</code>
* You can then use this program from the package to write the SPI device: <code>flashcp <filename> /dev/mtd0</code>

Even if you need to recover from a defective bootloader written to the SPI flash, you can simply short pin 6 of the SPI flash to GND and boot. This will render the SoC bootrom unable to read from the SPI flash and have it fall back to reading the bootloader from other boot media like the eMMC or Micro SD card.

The procedures described above are a lot less risky than attaching an external SPI flasher and do not require any additional hardware. At present, April 19th, 2020, there is no good bootloader image to flash into the SPI flash device. This is expected to change, as there are people working on issue.

= Software tuning guide =
Details on how to get the most out of a Pinebook Pro & its RK3399 SoC.

== Customizing the Pinebook Pro's default Manjaro KDE system ==
=== Watching DRM content (Netflix, etc.) ===
Most paid online streaming services use Widevine DRM to make their content more difficult to pirate. Widevine is not directly supported on Manjaro KDE, however it is still possible to watch DRM content via the "chromium-docker" package which downloads a 32-bit ARM container and installs Chromium with Widevine inside of that. While not space-efficient, or efficient in general, it's the recommended solution for watching this content on your Pinebook Pro. You can install this package with:
<pre>sudo pacman -Sy chromium-docker</pre>

=== Checking GPU capabilities ===
To see what versions of OpenGL and OpenGL ES are supported by the Pinebook Pro, what driver is in use, and what version of the driver is loaded, install the "mesa-demos" package with:
<pre>sudo pacman -Sy mesa-demos</pre>
And then run:
<pre>glxinfo | grep OpenGL</pre>
This will give detailed information about your graphics card and driver, useful for debugging.

=== Better GPU compatibility and performance ===
For better graphics performance, you may install the "mesa-git" package, built and supplied in the Manjaro ARM repos. This lets you bring in the latest features, optimizations, and bugfixes for the graphics driver used by the Pinebook Pro. Installation is as simple as:
<pre>pacman -Sy mesa-git</pre>
Then you may reboot to load the newer driver.

With Mesa 20.2 there is no longer much reason to use this over the standard mesa package, and applications may occasionally break with mesa-git.

[https://docs.mesa3d.org/bugs.html Reporting bugs] to the Mesa project will help make sure any problems are quickly fixed.

=== OpenGL 3.3 support ===
By default, with the current state of the Panfrost GPU driver, the Pinebook Pro supports OpenGL 2.1 and OpenGL ES 3.0. If you want to use OpenGL 3.3, you need to set the system-wide environment variable, open the '''/etc/environment''' file with:
<pre>kate /etc/environment</pre>
And then at the bottom of the file, on a new line, add:
<pre>PAN_MESA_DEBUG="gl3"</pre>
Then save the file, entering your password when prompted, and reboot the system. When you check your GPU capabilities, it should report OpenGL 3.3 and applications that rely on it should function properly. Note that GL 3.3 support is incomplete and some rendering features do not work yet, notably geometry shaders.

=== Install Anbox on Pinebook Pro Manjaro 20.10 ===
[https://www.youtube.com/watch?v=EU8_Q11dATs Youtube video on installing Anbox on Pienbook Pro Manjaro Build 20.10 by LivingLinux]

== Customizing the Pinebook Pro's previously-default Debian system ==
Here are some hints on what you can do to customize the Pinebook Pro's previous factory image (aka [https://github.com/mrfixit2001/debian_desktop mrfixit2001 debian build])

=== Initial user changes, password, name, etc ===
When you first get your Pinebook Pro, you should consider setting strong passwords and making the default account your own.

* Reboot (this is just to ensure all background processes belong to the user are not running... there are other ways to achieve this but this way is easy)
* Once the machine reboots press Alt-Ctrl-F1 to bring up a text terminal
* Login as root (login: root, password: root)
* Set a strong password for the root user using the following command and it's prompts:
<pre># passwd (and follow prompts)</pre>
* Rename the rock user to your prefered username (replace myself with whatever you like):
<pre># usermod -l myself -d /home/myself -m rock</pre>
* Rename the rock group to match your preferred username:
<pre># groupmod -n myself rock</pre>
* Put your name in the account, (replace "John A Doe" with your name):
<pre># chfn -f "John A Doe" myself</pre>
* Set a strong password for the normal user:
<pre># passwd myself</pre>
* Log out of the text terminal:
<pre># logout</pre>
* Press Alt-Ctrl-F7 to go back to the login screen and then login as the normal user
* Open text terminal to fix login error: "Configured directory for incoming files does not exist";
<pre>$ blueman-services</pre>
Select "Transfer" tab and set "Incoming Folder" to myself
OR
If adduser is in distro, this is MUCH easier
sudo adduser $USER ,, fill out requested data
Then,, sudo adduser $USER $GROUP,,, 1 group at a time
To see which groups to add,,, id $USER, id rock

=== Changing the default hostname ===
Debian 9 has a command to allow you to change the hostname. You can see the current settings using;
<pre>$ sudo hostnamectl
Static hostname: Debian-Desktop
Icon name: computer
Machine ID: dccbddccbdccbdccbdccbdccbdccbccb
Boot ID: ea99ea99ea99ea99ea99ea99ea99ea99
Operating System: Debian GNU/Linux 9 (stretch)
Kernel: Linux 4.4.210
Architecture: arm64</pre>
To change, use this, (with "My_Hostname" used as the example);
<pre>$ sudo hostnamectl set-hostname My_Hostname</pre>
Whence done, you can re-verify using the first example.

Then you should backup and edit your <code>/etc/hosts</code> entry's name;
<pre>$ sudo cp -p /etc/hosts /etc/hosts.`date +%Y%m%d`
$ sudo vi /etc/hosts
127.0.0.1 localhost
127.0.0.1 My_Hostname
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
127.0.1.1 linaro-alip</pre>

=== Disable Chromium browser's prompt for passphrase & password storage ===

Perform the following steps:

* On the tool bar, hover over the Chromium icon
* Using the right mouse button, select '''Properties'''
* In the '''Command:''' line section, add <code>--password-store=basic</code> before the <code>%U</code>
* Use the '''x Close''' button to save the change
This will of course, use basic password storage, meaning any saved passwords are not encrypted. Perfectly fine if you never use password storage.

=== Changing the boot splash picture ===

The default boot splash picture can be replaced using the following instructions:

* Install '''ImageMagick''' which will do the conversion
<pre>$ sudo apt-get install imagemagick</pre>
* Create a 1920 x 1080 picture. For the best results, use a PNG image (It supports lossless compression).
* From the directory in which your new image is stored run the following commands
* Convert your image to the bootsplash raw format using imagemagick convert.
<pre>$ convert yoursplashimage.png -separate +channel -swap 0,2 -combine -colorspace sRGB RGBO:splash.fb</pre>
* Create a backup copy of your current splash screen
<pre>$ sudo cp /usr/share/backgrounds/splash.fb /usr/share/backgrounds/splash_original.fb</pre>
* Copy your new splash screen into place
<pre>$ sudo cp splash.fb /usr/share/backgrounds/splash.fb</pre>
* Set the correct permissions on the splash.fb file
<pre>$ sudo chmod 644 /usr/share/backgrounds/splash.fb</pre>
* If you do not want to see kernel console text messages, make sure you don't have '''Plymouth''' installed

=== Watching Amazon Prime videos with Chromium ===
When you create a new user, it will be necessary to launch the Chromium browswer with a specific user agent like below;
<pre>chromium-browser --user-agent="Mozilla/5.0 (X11; CrOS armv7l 6946.63.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36"</pre>
There may be more tweaks needed.

=== Enabling text boot time messages ===

By default, most Linux distros have a boot screen with a picture. To see all the boot time messages, use one of the following;

==== Debian ====
* Backup and edit the U-Boot configuration file:

cp -p /etc/default/u-boot /etc/default/u-boot.`date +%Y%m%d`
chmod a-w /etc/default/u-boot.`date +%Y%m%d`
vi /etc/default/u-boot

Remove the '''quiet''' and '''splash''' parameters. Leave everything else alone.

* Update the U-Boot configuration:

u-boot-update

* Test and verify you get what you think you should be seeing.

==== Manjaro ====
* Backup and edit the U-Boot configuration file:

cp -p /boot/extlinux/extlinux.conf /boot/extlinux/extlinux.conf.`date +%Y%m%d`
chmod a-w /boot/extlinux/extlinux.conf.`date +%Y%m%d`
vi /boot/extlinux/extlinux.conf

* Change '''console=ttyS2,1500000''' to '''console=tty1'''
* Remove the '''bootsplash.bootfile''' option and it's parameter.
* You can add verbose logging by appending '''ignore_loglevel''' to the line where boot splash was.
* Leave everything else alone.
* Test and verify you get what you think you should be seeing.

== Improving readability ==

Some people find that a 14" LCD screen with 1080p, (1920 x 1080), has text and icons a bit too small. There are things you can do to make the screen easier to use and read. 
* Increase the font size
* Use a font with more pronounced features
* Increase the various window manager sizes (e.g. increase the height of the tool bar)
* Change the color scheme to be easier on the eyes. Higher contrast can help usability.
* Change the window manager's decorations (e.g. use larger icons)
* Use a workspace manager, with one application per workspace
* When at home or office, use an external monitor
* Change the X-Windows DPI. One such method that someone used successfully, is: <blockquote><code>echo "Xft.dpi: 150" >> ~/.Xresources</code></blockquote>Change the 150 as desired to get the size adjustment you want.
 
However, do not change the resolution of the LCD screen, otherwise you may end up with a blank / black screen. If that happens, see this troubleshooting section for the fix: 
[[Pinebook_Pro#After_changing_builtin_LCD_resolution.2C_blank_screen|Blank screen after changing builtin LCD resolution]]

== Chromium tweaks ==

=== Flags ===

From the [https://github.com/mrfixit2001/updates_repo/blob/v1.8/pinebook/filesystem/default official Debian image]:

<pre>
--disable-low-res-tiling \
--num-raster-threads=6 \
--profiler-timing=0 \
--disable-composited-antialiasing \
--test-type \
--show-component-extension-options \
--ignore-gpu-blacklist \
--use-gl=egl \
--ppapi-flash-path=/usr/lib/chromium-browser/pepper/libpepflashplayer.so \
--ppapi-flash-version=32.0.0.255 \
--enable-pinch \
--flag-switches-begin \
--enable-gpu-rasterization \
--enable-oop-rasterization \
--flag-switches-end
</pre>

Note that in some cases, this may also decrease performance substantially, as observed when using these flags on the Manjaro KDE desktop. Feel free to experiment to find what is smoothest for you personally.

== gVim has performance issue ==
It appears that using GTK3 can cause very slow scrolling, while Vim in a terminal window works fine. 
Simply revert back to using GTK2, (how to do so is somewhat Linux distro-specific).

Another solution may be to run gVim with

GDK_RENDERING=image

environment variable set. It seems that this improves the performance by reverting back to software-only rendering.

== Kernel options ==
Here are some Pinebook Pro & its RK3399 SoC Linux specific options. If kernel version, (or version range specific), it should list that information in the description.

To see if a specific feature is enabled in the current kernel, you can use something like this;

<pre>
$ zgrep -i rockchip_pcie /proc/config.gz
# CONFIG_ROCKCHIP_PCIE_DMA_OBJ is not set
CONFIG_PHY_ROCKCHIP_PCIE=m
</pre>
If it's listed as <code>=m</code>, then it's a module. You can see if the module is loaded with;
<pre>
$ lsmod | grep -i rockchip_pcie
phy_rockchip_pcie 16384 0
</pre>
Note modules are not loaded until needed. Thus, we sometimes check the kernel configuration instead to see if a feature is configured first, then see if it's a module.

=== Hardware video decoding ===
Here is a method to check for hardware video decoding by the VPU. There are special Linux kernel modules that perform this function. 
Older systems, such as the previously-default Debian desktop, use the Rockchip-supplied kernel module <code>rk-vcodec</code>. To check, something like this can be used:
<pre>
$ lsmod | grep rk-vcodec
or
$ zgrep RK_VCODEC /proc/config.gz
CONFIG_RK_VCODEC=y
</pre>
Note that in the above example, the Rockchip video CODEC is not built as a module, but included into the kernel. Thus, it does not show up in the list modules check. 
 

Newer systems may use a different option as in the configuration below:
<pre>
$ zgrep HANTRO /proc/config.gz
CONFIG_VIDEO_HANTRO=m
CONFIG_VIDEO_HANTRO_ROCKCHIP=y
</pre>

= Troubleshooting guide =

Do not panic if something goes wrong or in an unexpected way. Instead, stop and consider carefully how to undo something, or how to redo it. This particularly applies when flashing a new operating system, or flashing new firmware to the keyboard or touchpad. If everything fails, consider reporting the issue on the forums, with as many relevant details as available.

Please, have a look at the [[Pinebook Pro Troubleshooting Guide]], which details a number of issues you may encounter.

= Hardware/Accessory Compatibility =
Please contribute to the [[Pinebook Pro Hardware Accessory Compatibility|hardware/accessory compatibility page]], which lists the status of hardware tested with the Pinebook Pro. Available hardware categories include the following:

* [[Pinebook Pro Hardware Accessory Compatibility#NVMe SSD drives|NVMe SSD drives]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB hardware|USB hardware]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB C alternate mode DP|USB-C alternate mode DP]]
* [[Pinebook Pro Hardware Accessory Compatibility#Other hardware|Other hardware]]

= Technical Reference =
== Disassembly and Reassembly ==
[[File:Standoffs.png|400px|thumb|right|Pinebook Screw stand-offs correct placement and location]]

[[File:Hinges_cover_removed_1.jpeg|300px|thumb|right|Hinge area of the Pinebook Pro lid with the cover removed]]
[[File:Hinges_cover_removed_2.jpeg|300px|thumb|right|Close-up of a Pinebook Pro lid hinge]]

There are a few '''mandatory''' precautions to be taken:

* Do not open the laptop by lifting the lid while the Pinebook Pro bottom cover is removed - this can cause structural damage to the hinges and/or other plastic components of the chassis such as the IO port cut-outs.
* When removing the back cover plate, *do not, under any circumstances, slide your fingertips between the metal shell and the plastic frame!* The back cover plate edges are sharp, and when combined with the pressure and movement generated from, specifically, attempting to slide the tips of your fingers along the bottom edge of the plate along the lid-hinge, they *will* slice open the tips of your fingers like a knife.
* When removing the back cover plate, use care to avoid damaging the speakers. They can be stuck to the back cover with double-sided tape, and the thin wires are very delicate. Newer Pinebook Pro laptops (as of the May 2021 batch, and perhaps earlier) seem to lack the double-sided tape to the rear cover, instead opting for tape or glue that makes them stick to the front cover. Nevertheless, be gentle when removing the back cover.

[[File:PinebookProScrewGuide.png|400px|thumb|right|Pinebook Pro external screws (this particular unit has suffered damage on screw (4)L)]]

When disassembling the laptop make sure that it is powered off and folded closed. To remove the bottom cover of the Pinebook Pro, first remove the ten (10) Phillips head screws that hold the bottom section of the laptop in place. There are four (4) short screws along the front edge, and six (6) long screws along the 3 remaining sides. Remove the cover from the back where the hinges are situated by lifting it up and away from the rest of the chassis. The aluminum case is held on only by screws. There are no plastic snaps, and the shell should pull away without any effort. If you experience any resistance at all stop and ensure all ten (10) screws are accounted for.

During reassembly, make sure that the back-screw standoffs are in place and seated correctly. Before replacing the aluminum back-plate, ensure that the speakers are properly seated by pressing gently on the hard plastic edge of the speaker module. Slide the bottom section into place so it meets the front lip of the keyboard section. Secure the front section (where the touchpad is located) in place using the short screws in the front left and right corners. Then proceed to pop in the bottom panel into place. Secure the bottom section (where hinges are located) by screwing in the left and right corners. Then screw in the remaining screws and run your finger though the rim on the chassis to make sure its fitted correctly. Note that the front uses the remaining 4 short screws.

The screws are small and should only be finger tight. Too much force will strip the threads. If after installing screws the back cover plate has not seated properly on one side (which may be caused by the aforementioned misseating of the speakers), open the display and hold the base on either side of the keyboard and gently flex the base with both hands in opposing directions. Once the side pops further in, then recheck the screws on that side. If it does not pop back in, re-open the machine and check for misseated components.

A basic 3D model to print replacement standoffs for the back cover screws is [https://www.thingiverse.com/thing:4226648 available on Thingiverse], until the official drawings or 3D models are made available.

====Display Disassembly====
It is not recommended to adjust the position of the lid when the bottom cover is removed, because the bottom cover provides structural strength, so the lid should be open fully as the first step, before starting any disassembly of the laptop. After opening the lid, remove the bottom cover by following the instruction found in the section above. Alternatively, you can keep the lid closed and remove the screws that hold the hinges to the main laptop body, as described in [[Pinebook Service Step by Step Guides]].

Parts of the hinge mechanism, as well as the screws that hold the hinges to the lid, are hidden behind an elongated plactic U-shaped cover that snaps in place using latches. Use a dedicated plastic prying tool or a guitar pick to gently pry the cover and remove it, starting from the outer edge. Once you pry the cover to a certain extent, it should be possible to remove it fully using only your hands. The U-shaped cover is rather sturdy, but still be careful not to break or bend it.

There are two small screws hidden underneath the two small rubber nubs on the upper part of the screen bezel, so first gently remove the nubs and then remove the screws. The screen bezel is held in place with a combination of latches and some adhesive tape, which is there to prevent dust ingress. The adhesive isn't very strong, and the bezel is capable of flexing back into shape after being twisted to a certain extent. There is more adhesive on the bottom part of the screen bezel, so be more careful while prying that section apart. Use the same prying tool that you used for the U-shaped cover, and work it around the outer edges of the screen bezel.

== Internal Layout ==

=== Main chips ===
* RK3399 system-on-chip (1)
* LPDDR4 SDRAM (21)
* SPI NOR flash memory (29)
* eMMC flash memory (26)
* WiFi/BT module (27)

=== Mainboard Switches and Buttons ===
There are two switches on the main board: disabling the eMMC (24), and enabling UART (9) via headphone jack.

The Reset and Recovery buttons (28): the reset button performs an immediate reset of the laptop. The Recovery button is used to place the device in maskrom mode; this mode allows flashing eMMC using Rockchip tools (e.g. rkflashtools).

[[File:PBPL_S.jpg]]

=== Key Internal Parts ===
{| class="wikitable"
|+ Numbered parts classification and description
! Number
! Type
! Descriptor
|-
! scope=row | 1
| Component || RK3399 System-On-Chip
|-
! scope=row | 2
| Socket || PCIe x4 slot for optional NVMe adapter
|-
! scope=row | 3
| Socket || Speakers socket
|-
! scope=row | 4
| Socket || Touchpad socket
|-
! scope=row | 5
| Component || Left speaker
|-
! scope=row | 6
| Connector || Power bridge connector
|-
! scope=row | 7
| Socket || Keyboard Socket
|-
! scope=row | 8
| Component || Optional NVMe SSD adapter
|-
! scope=row | 9
| Switch || UART/Audio switch - outputs UART via headphone jack
|-
! scope=row | 10
| Socket || Power bridge socket
|-
! scope=row | 11
| Socket || Battery socket
|-
! scope=row | 12
| Component || Touchpad
|-
! scope=row | 13
| Component || Battery
|-
! scope=row | 14
| Component || Right speaker
|-
! scope=row | 15
| Socket || MicroSD card slot
|-
! scope=row | 16
| Socket || Headphone / UART jack
|-
! scope=row | 17
| Socket || USB 2.0 Type A
|-
! scope=row | 18
| Socket || Daughterboard-to-mainboard ribbon cable socket
|-
! scope=row | 19
| Cable || Daughterboard-to-mainboard ribbon cable
|-
! scope=row | 20
| Component || microphone
|-
! scope=row | 21
| Component || LPDDR4 RAM
|-
! scope=row | 22
| Socket || Mainboard-to-daughterboard ribbon cable socket
|-
! scope=row | 23
| Socket || Microphone socket
|-
! scope=row | 24
| Switch || Switch to hardware disable eMMC
|-
! scope=row | 25
| Antenna || BT/WiFI antenna
|-
! scope=row | 26
| Component || eMMC flash memory module
|-
! scope=row | 27
| Component ||BT/WiFi module chip
|-
! scope=row | 28
| Buttons || Reset and recovery buttons
|-
! scope=row | 29
| Component || SPI flash storage
|-
! scope=row | 30
| Socket || eDP LCD socket
|-
! scope=row | 31
| Socket || Power in barrel socket
|-
! scope=row | 32
| Socket || USB 3.0 Type A
|-
! scope=row | 33
| Socket || USB 3.0 Type C
|}

=== Smallboard detailed picture ===

[[File:Pinebook_pro_smallboard.jpg]]

== Bootable Storage ==

=== Boot sequence details ===
The RK3399's mask 32KB ROM boot code looks for the next stage of code at byte off-set 32768, (sector 64 if using 512 byte sectors). This is where U-Boot code would reside on any media that is bootable. 
[[RK3399_boot_sequence|RK3399 boot sequence]]

=== Boot devices ===

The Pinebook Pro is capable of booting from eMMC, USB 2.0, USB 3.0, or an SD card. It cannot boot from USB-C. The boot order of the hard-coded ROM of its RK3399 SoC is: SPI NOR, eMMC, SD, USB OTG.

At this time, the Pinebook Pro ships with a Manjaro + KDE build with [https://www.denx.de/wiki/U-Boot/ u-boot] on the eMMC. Its boot order is: SD, USB, then eMMC.

(An update has been pushed for the older Debian + MATE build that improves compatibility with booting other OSes from an SD card. In order to update, fully charge the battery, establish an internet connection, click the update icon in the toolbar, and then reboot your Pinebook Pro. Please see [https://forum.pine64.org/showthread.php?tid=7830 this log] for details.)

Please note that PCIe, the interface used for NVMe SSD on the Pinebook Pro, is not bootable on the RK3399 and therefore is not a part of the boot hierarchy. It is possible to run the desired OS from NVMe by pointing extlinux on the eMMC to rootfs on the SSD. This requires uboot, the Kernel image, DTB, and extlinux.conf
in a /boot partition on the eMMC.

=== eMMC information ===
The eMMC appears to be hot-pluggable. This can be useful if trying to recover data or a broken install. Best practice is probably to turn the eMMC switch to off position before changing modules. Note that the enable/disable label on the silkscreen is incorrect on some board revisions (known bad on v2.1).

The eMMC storage will show up as multiple block devices:
*mmcblk1boot0 - eMMC standard boot0 partition, may be 4MB
*mmcblk1boot1 - eMMC standard boot1 partition, may be 4MB
*mmcblk1rpmb - eMMC standard secure data partition, may be 16MB
*mmcblk1 - This block contains the user areas

Only the last is usable as regular storage device in the Pinebook Pro.
The device number of "1" shown above may vary, depending on kernel.

If the eMMC module is enabled after boot from an SD card, you can detect this change with the following commands as user "root";
<pre>
echo fe330000.mmc >/sys/bus/platform/drivers/sdhci-arasan/unbind
echo fe330000.mmc >/sys/bus/platform/drivers/sdhci-arasan/bind
</pre>

(Note: with the device trees coming with older kernels (Linux < 5.11), the device name may be fe330000.sdhci instead of fe330000.mmc)

== Case Dimensions and Data ==
* Dimensions: 329mm x 220mm x 12mm (WxDxH)
* Weight: 1.26Kg
* Screws
** Philips head type screws
** M2 flat head machine screws (measurements in mm)
** 4 x Small screws (used along the front edge): Head - 3.44, Thread Diameter - 1.97, Thread Length - 2.1, Overall length - 3.05
** 6 x Large screws: Head - 3.44, Thread Diameter - 1.97, Thread Length - 4.41, Overall Length - 5.85
* Rubber Feet
** 18mm diameter
** 3mm height
** Dome shaped

== SoC and Memory Specification ==
[[File:Rockchip_RK3399.png|right]]
* Based on Rockchip RK3399

=== CPU Architecture ===
* big.LITTLE architecture: Dual Cortex-A72 + Quad Cortex-A53, 64-bit CPU
** Full implementation of the ARM architecture v8-A instruction set (both AArch64 and AArch32)
** ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
** ARMv8 Cryptography Extensions
** VFPv4 floating point unit supporting single and double-precision operations
** Hardware virtualization support
** TrustZone technology support
** Full CoreSight debug solution
** One isolated voltage domain to support DVFS
* Cortex-A72 (big cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a72 Dual-core Cortex-A72 up to 2.0GHz CPU]
** Superscalar, variable-length, out-of-order pipeline
** L1 cache 48KB Icache and 32KB Dcache for each A72
** L2 cache 1024KB for big cluster
* Cortex-A53 (little cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a53 Quad-core Cortex-A53 up to 1.5GHz CPU]
** In-order pipeline with symmetric dual-issue of most instructions
** L1 cache 32KB Icache and 32KB Dcache for each A53
** L2 cache 512KB for little cluster
* Cortex-M0 (control processors):
** [https://developer.arm.com/ip-products/processors/cortex-m/cortex-m0 Cortex-M0 CPU]
** Two Cortex-M0 cooperate with the central processors
** Architecture: Armv6-M
** Thumb/Thumb2 instruction set
** 32 bit only

=== GPU Architecture ===
* [https://developer.arm.com/products/graphics-and-multimedia/mali-gpus/mali-t860-and-mali-t880-gpus ARM Mali-T860MP4 Quad-core GPU]
* The highest performance GPUs built on Arm Mali’s famous Midgard architecture, the Mali-T860 GPU is designed for complex graphics use cases and provide stunning visuals for UHD content.
* Frequency 650MHz
* Throughput 1300Mtri/s, 10.4Gpix/s
* Graphic interface standards:
** OpenGL® ES 1.1, 1.2, 2.0, 3.0, 3.1, 3.2. (Panfrost has initial support of 3.0 beginning 2020/02/27)
** Vulkan 1.0, using the Mali binary blob. (Panfrost does not support Vulkan as of 2020/06/24)
** OpenCL™ 1.1, 1.2
** DirectX® 11 FL11_1
** RenderScript™

=== System Memory ===
* RAM Memory:
** LPDDR4
** 800MHz, (limited by RK3399)
** Dual memory channels on the CPU, each 32 bits wide
** Quad memory channels on the RAM chip, each 16 bits wide, 2 bonded together for each CPU channel
** 4GB as a single 366 pin mobile RAM chip
* Storage Memory:
** 64GB eMMC module, can be upgraded to an 128GB eMMC module. (The initial PINE64 community build version shipped with a 128GB eMMC.)
** eMMC version 5.1, HS400, 8 bit on RK3399 side
** Bootable
* SPI flash:
** [[Pinebook Pro SPI]]
** 128Mbit / 16MByte
** 1 bit interface
** Bootable, (first boot device, ahead of eMMC & SD card)
** U-Boot images can be made to work, but as of 2020/06/24 there is no standardized image available.

=== Video out ===
* USB-C Alt mode DP
* Up to 3840x2160 p60, dependant on adapter, (2 lanes verses 4 lanes)

=== Expansion Ports ===
* MicroSD card:
** Bootable
** Supports SD, SDHC and SDXC cards, up to 512GB tested. SDXC standard says 2TB is the maximum.
** Version SD3.0, (MMC 4.5), up to 50MB/s
** SD card Application Performance Class 1 (A1), (or better), recommended by some users, for better IOPS
* USB ports:
** 1 x USB 2.0 Type-A Host Port, bootable
** 1 x USB 3.0 Type-A Host Port, 5Gbps, is not bootable
** 1 x USB 3.0 Type-C OTG Port, 5Gbps, (includes laptop charging function), is not bootable
** Note that high power USB devices may not work reliably on a PBP. Or they may draw enough power to drain the battery even when the PBP is plugged into A.C. One alternative is externally powered USB devices.
* Headphone jack switchable to UART console mux circuit

== Additional hardware ==
Hardware that is not part of the SoC.

=== Battery ===
* Lithium Polymer Battery (10,000 mAH)

=== Display ===
* 14.0" 1920x1080 IPS LCD panel
=== Lid closed magnet ===
There is a magnet to detect when the laptop lid is closed, so action can be taken like sleep. This meets up with the Hall sensor on the daughter / small board to detect lid closed.
* The magnet is located on the LCD panel right side, around 1.5 inches up measure from bottom edge.

=== Webcam ===
* Internal USB attached Webcam

=== Audio ===
* 3.5mm stereo earphone/microphone plug
* Built-in microphone
* Built-in stereo speakers:
** Oval in design
** 3 mm high x 20 mm x 30 mm

=== Network ===
* WiFi:
** 802.11 b/g/n/ac
** Dual band: 2.4Ghz & 5Ghz
** Single antenna
* Bluetooth 5.0

=== Optional NVMe adapter ===
* PCIe 1.1, 2.5 GT/s per lane
** Note that due to errata, PCIe is limited to Gen1. See [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/arch/arm64/boot/dts/rockchip/rk3399.dtsi?id=712fa1777207c2f2703a6eb618a9699099cbe37b this commit].
* Four PCIe lanes, which can not be bifurcated, but can be used with one- or two-lane NVMe cards
* '''M''' keyed, though '''M'''+'''B''' keyed devices will work too
* Maximum length for M.2 card is 80mm (M.2 2280). The following sizes will also work: 2230, 2242, 2260
* Power: 2.5 W continuous, 8.25 W peak momentary
* Does not support SATA M.2 cards
* Does not support USB M.2 cards

== Pinebook Pro Schematics and Certifications ==
* Pinebook Pro Main Board Schematic And Silkscreen:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_mainboard_schematic.pdf Pinebook Pro Main Board ver 2.1 Schematic]
** [https://wiki.pine64.org/images/3/30/Pinebookpro-v2.1-top-ref.pdf Pinebook Pro ver 2.1 Top Layer Silkscreen]
** [https://wiki.pine64.org/images/b/b7/Pinebookpro-v2.1-bottom-ref.pdf Pinebook Pro ver 2.1 Bottom Layer Silkscreen]
* Pinebook Pro Daughter Board Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_daughterboard_schematic.pdf Pinebook Pro Daughter Board ver 2.1 Schematic]
* Optional Pinebook Pro NVMe Adapter Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_NVMe-adapter_schematic.pdf Pinebook Pro NVMe Adapter Board ver 2.1 Schematic]
* Serial Console Earphone Jack Pinout:
** [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pinebook Serial Console Earphone Jack Pinout]
* Pinebook Pro Case:
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.pdf AutoCAD PDF File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.ai AutoCAD AI File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.dwg AutoCAD DWG File ]
* Pinebook Pro Certifications:
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20FCC%20Certificate-S19071103501001.pdf Pinebook Pro FCC Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20CE%20RED%20Certificate-S19051404304.pdf Pinebook Pro CE Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20ROHS%20Compliance%20Certificate.pdf Pinebook Pro RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3399 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2016/0419/758.html Rockchip RK3399 SoC Brief]
** [https://opensource.rock-chips.com/images/d/d7/Rockchip_RK3399_Datasheet_V2.1-20200323.pdf Rockchip RK3399 Datasheet v2.1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.4%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.4, part 1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.3, part 1] and [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part2.pdf part 2]
** [https://files.pine64.org/doc/datasheet/rockpro64/RK808%20datasheet%20V0.8.pdf Rockchip RK808 Datasheet v0.8]
* LPDDR4 SDRAM (366-pin BGA):
** [https://files.pine64.org/doc/datasheet/PinebookPro/micron%20SM512M64Z01MD4BNK-053FT%20LPDDR4%20(366Ball).pdf Micron 366 balls 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/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 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://wiki.pine64.org/images/b/b9/Ds-00220-gd25q127c-rev1-df2f4.pdf GigaDevice 128Mb SPI Flash Datasheet (updated)]
* Wireless and Bluetooth information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/AP6256%20datasheet_V1.7_12282018.pdf AMPAK AP6256 11AC Wi-Fi + Bluetooth5 Datasheet]
* Audio codec:
** [http://www.everest-semi.com/pdf/ES8316%20PB.pdf Everest ES8316 Audio Codec Datasheet]
* LCD panel:
** [https://files.pine64.org/doc/datasheet/PinebookPro/NV140FHM-N49_Rev.P0_20160804_201710235838.pdf 14" 1920x1080 IPS LCD Panel datasheet]
* USB-related information:
** Internal USB 2.0 hub: [https://wiki.pine64.org/images/3/39/GL850G_USB_Hub_1.07.pdf GL850G USB Hub Datasheet]
** USB Type-C Controller: [https://www.onsemi.com/pub/Collateral/FUSB302-D.PDF ON Semiconductor FUSB302 Datasheet]
* Touchpad information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/YX%20HK-9562%20HID%20I2C%20Specification.pdf PineBook Pro Touchpad Specification]
* Keyboard information:
** [https://wiki.pine64.org/images/b/b0/SH68F83V2.0.pdf Sinowealth SH68F83 Datasheet]
** US ANSI: XK-HS002 MB27716023
* Full HD camera sensor:
** [https://files.pine64.org/doc/datasheet/PinebookPro/HK-2145-263.pdf Full HD Camera module specification (in Chinese)]
** [https://files.pine64.org/doc/datasheet/PinebookPro/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GalaxyCore GC2145 Full HD Camera Sensor Datasheet]
* Battery-related information:
** Battery charging IC: [https://www.ti.com/lit/ds/symlink/bq24171.pdf?ts=1607068456825&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FBQ24171 Texas Instruments BQ24171 Datasheet]
** Battery monitoring IC: [https://cdn.datasheetspdf.com/pdf-down/C/W/2/CW2015-Cellwise.pdf Cellwise CW2015 Datasheet]
** [https://files.pine64.org/doc/datasheet/pinebook/40110175P%203.8V%2010000mAh规格书-14.pdf 10000mAH Lithium Battery Specification]
* Power path device:
** [https://wiki.pine64.org/images/9/99/Sis412dn.pdf N-MOS / MOSFET]
* NVMe adapter:
** [https://wiki.pine64.org/images/d/d0/Hirose-FH26W-35S-0.3SHW%2860%29-datasheet.pdf FH26-35S-0.3SHW flat flex connector (compatible, not OEM)]

== Versions ==
Pinebook Pro v1 and v2 were prototype models that did not make it to the public. The "first batch" (First 100 forum preorders) onward are v2.1. [https://forum.pine64.org/showthread.php?tid=8111]

=Skinning and Case Customization=
* Template files for creating custom skins. Each includes template layers for art placement, and CUT lines.
**[https://drive.google.com/open?id=1UKFlC53DO0GJm3Hz1E_669n_HhI45e4n Case Lid Template]
**[https://drive.google.com/open?id=1Q6bKGarMDhvWz3HdGvhL5qDhyHb546ve Case Bottom Template]
**[https://drive.google.com/open?id=1ugI74ygNJ3EN5jXks5jKvdpEAoxIzHo4 Case Palmrest Template]

= Other Resources =
* [https://forum.pine64.org/forumdisplay.php?fid=111 Pinebook Pro Forum]
* [https://forum.pine64.org/forumdisplay.php?fid=98 ROCKPro64 Forum]
* [https://riot.im/app/#/room/#pinebook:matrix.org Matrix Channel] (no login required to read)
* IRC Server: irc.pine64.org Channel: PineBook
* [https://discordapp.com/channels/463237927984693259/622348681538043924 Discord Channel]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [[Pinebook Pro/Freepascal and Lazarus IDE on Manjaro|Freepascal and Lazarus IDE on Pinebook Pro]]

[[Category:PineBook Pro]]
[[Category:Rockchip RK3399]]

Pinebook Pro

2022-09-21T18:15:01Z

CameronNemo: Improve grammar. Also systemd services do not need to be made executable.

= User Guide =
== Introducing PineBook Pro ==
[[File:PBP.jpg|400px|thumb|right|Pinebook Pro running Debian with MATE]]

The Pinebook Pro is a Linux and *BSD ARM laptop from [https://www.pine64.org/ PINE64]

It is built to be a compelling alternative to mid-ranged Chromebooks that people convert into Linux laptops. It features an IPS 1080p 14″ LCD panel, a premium magnesium alloy shell, high capacity eMMC storage, a 10,000 mAh capacity battery, and the modularity that only an open source project can deliver.

It's compact and slim dimensions are 329mm x 220mm x 12mm (WxDxH).

Key features include: the RK3399 SOC; USB-C for data, video-out and power-in (3A 5V); privacy switches for the microphone, BT/WiFi module, and camera; and expandable storage via NVMe (PCIe x4) with an optional adapter.

The Pinebook Pro is equipped with 4GB LPDDR4 system memory, high capacity eMMC flash storage, and 128Mb SPI boot Flash. The I/O includes: 1 x micro SD card reader (bootable), 1 x USB 2.0, 1 x USB 3.0, 1 x USB type C Host with DP 1.2 and power-in, PCIe x4 for an NVMe SSD drive (requires an optional adapter), and UART (via the headphone jack by setting an internal switch).

The keyboard and touchpad both use the USB 2.0 protocol. The LCD panel uses eDP MiPi display protocol.

Many different Operating Systems (OS) are freely available from the open source community and partner projects. These include various flavors of Linux (Ubuntu, Debian, Manjaro, etc.) and *BSD.

== Software and OS Image Downloads ==

=== Default Manjaro KDE Desktop Quick Start ===

When you first get your Pinebook Pro and boot it up for the first time, it'll come with Manjaro using the KDE desktop. The Pinebook Pro is officially supported by the Manjaro ARM project, and support can be found on the [https://forum.manjaro.org/c/manjaro-arm/78 Manjaro ARM forums.]

On first boot, it will ask for certain information such as your timezone location, keyboard layout, username, password, and hostname. Most of these should be self-explanatory. Note that the hostname it asks for should be thought of as the "codename" of your machine, and if you don't know what it's about, you can make something up (use a single word, all lower case, no punctuation; e.g. "pbpro").

After you're on the desktop, be sure to update it as soon as possible and reboot after updates are finished installing. If nothing appears when you click on the Networking icon in your system tray to connect to your Wi-Fi, ensure the Wi-Fi [https://wiki.pine64.org/index.php/Pinebook_Pro#ANSI_Fn_.2B_F_keys_wrong_for_F9.2C_F10.2C_F11_and_F12 privacy switch] is not disabled.

=== Pinebook Pro images ===
Under [[Pinebook Pro Software Release]] you will find a complete list of currently supported Operating System images that work with the Pinebook as well as other related software.

The list includes OS images and descriptions of:

* [[PinebookPro_Software_Release#Manjaro ARM|Manjaro ARM]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Armbian|Armbian]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Twister OS|Twister OS]] (microSD Boot)
* [[PinebookPro_Software_Release#Fedora|Fedora]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Arch_Linux_ARM|Arch Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#postmarketOS|Postmarket OS]] (microSD and USB boot)
* [[PinebookPro_Software_Release#Kali Linux|Kali Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#DietPi|DietPi]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Q4OS|Q4OS]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#NetBSD|NetBSD]] (microSD and eMMC Boot)
* [[Pinebook_Pro_Software_Release#OpenBSD|OpenBSD release for ARM64]]
* [[Pinebook_Pro_Software_Release#Gentoo|Gentoo]]
* [[Pinebook_Pro_Software_Release#Slackware|Slackware (microSD boot)]]
* [[Pinebook_Pro_Software_Release#Void_Linux|Void Linux]]

== Keyboard ==
The Pinebook Pro is available in two keyboard configurations: ISO and ANSI. Both the keyboard and touchpad in the Pinebook Pro use the USB 2.0 protocol and show up as such in xinput. The keyboard features function (Fn) keys in the F-key row, which include display brightness controls, sound volume, touchpad lock, and other functionality. There is also a custom PINE64 logo key that functions as Menu/Super key. It has also a secondary functionality for setting the privacy switches.

The keyboard firmware binary can be flashed from userspace using the provided open source utility.

{{warning|DO NOT update the keyboard firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed, see the [https://reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Documentation for the keyboard can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]].

=== Typing special characters ===
The [[Wikipedia:British_and_American_keyboards#Other_keyboard_layouts|UK ISO Layout]] does not have dedicated keys for characters like the German umlauts (Ä,Ö,Ü, etc). Certain characters can still be generated by means of either key combinations or key sequences.
{| class="wikitable"
!Character
!Key combination/sequence
|-
|Ä, Ö, Ü, ä, ö, ü
|[[Wikipedia:AltGr_key|[AltGr]]]+'[' followed by [A], [O], [U], [a], [o] or [u]
|-
|µ
|[AltGr]+[m]
|-
|Ø, ø
|[AltGr]+[O], [AltGr]+[o]
|-
|@
|[AltGr]+[q] (as on the German layout)
|-
|ß
|[AltGr]+[s]
|-
|§
|[AltGr]+[S]
|-
|°
|[AltGr]+[)]
|}

=== Privacy Switches ===
There are three privacy switches mapped to the F10, F11 and F12 keys on the Pinebook Pro keyboard. They de/activate the following:

{| class="wikitable"
|+ Privacy switch function and description
! Combination
! Effect
! Description
! Notes
|-
! scope=row | PINE64 logo key+F10
| Microphone Privacy switch
| CAPs lock LED blinks. 2 blinks = enabled, 3 blinks = disabled
|-
! scope=row | PINE64 logo key+F11
| WiFi Privacy switch
| NUM lock LED blinks. 2 blinks = WiFi enabled / privacy switch disabled, 3 blinks = WiFi disabled / privacy switch enabled.
| '''Re-enabling requires reboot''' (or a [//forum.pine64.org/showthread.php?tid=8313&pid=52645#pid52645 command line hack to bind/unbind]).
|-
! scope=row | PINE64 logo key+F12
| Camera privacy switch
| CAPs lock and NUM lock LEDs blink together. 2 blinks = enabled, 3 blinks = disabled
| Can use tools like '''<code>lsusb</code>''' to detect camera's presence. If not detected, check privacy switch.
|}

'''(Press the PINE64 logo key plus F10/F11/F12) for 3 seconds)'''

The keyboard operates on firmware independent of the operating system. It detects if one of the F10, F11 or F12 keys is pressed in combination with the Pine key for 3 seconds. Doing so disables power to the appropriate peripheral, thereby disabling it. This has the same effect as cutting off the power to each peripheral with a physical switch. This implementation is very secure, since the firmware that determines whether a peripheral gets power is not part of the Pinebook Pro’s operating system. So the power state value for each peripheral cannot be overridden or accessed from the operating system. The power state setting for each peripheral is stored across reboots inside the keyboard's firmware flash memory.

=== Basic summary of replacing keyboard ===

This guide is very basic and should be fleshed out with (better) pictures. There just isn't a list of steps anywhere else yet.

Here's what the replacement keyboard looks like:

[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (front)]]
[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (back)]]

''Step 0'': If changing from ISO keyboard to ANSI keyboard, or vice versa, be sure to have a system capable of running the firmware updater that you can access either remotely or with a USB keyboard beyond the internal keyboard, as the firmware for each is very different and keys won't work correctly. See https://forum.pine64.org/showthread.php?tid=8407 (and for NetBSD, https://forum.pine64.org/showthread.php?tid=8716).

''Step 1'': The remove back back panel.

There are 10 screws on the back that must be removed, and the back panel detached. I recommend using a PH0 bit. The speakers may remain attached via glue to the case and should be carefully pried off. When this is done, taking photos of how everything looks now can help put it all back together later.

[[File:Pinebook_Pro_keyboard-replacement-screws.jpg|300px|Remove the back panel]]

''Step 2'': Places to unscrew.

There are 3 items screwed into the keyboard frame that must be removed. There are 2 large screws for daughter board, 3 large screws and 1 small screw for mainboard, and 4 small screws for battery. Be sure to not lose them. I recommend a PH00 bit for the large screws on the daughter and main boards and a PH1 bit for the small screws on the battery and mainboard.

[[File:Pinebook_Pro_new_keyboard-back-removed.jpg|300px|Remove the back panel]]

''Step 3'': Remove the battery.

Once the battery screws are removed, it should be unplugged from the mainboard and removed. Note that there are two unconnected cables lying around, that should remain unconnected. They are used when the battery is disconnected entirely.

[[File:Pinebook_Pro_new_keyboard-zoom-mainboard.jpg.jpg|300px|Zoom on the mainboard]]
[[File:Pinebook_Pro_new_keyboard-zoom-daughterboard.jpg|300px|Zoom on the daughterboard]]

''Step 4'': Unplug the ribbon cables.

NOTE: you should remove the M.2 adapter board now if you have one installed. See elsewhere in this wiki for instructions on how to install/remove that piece.

There are several ribbon cables. To remove, flip up the tab and gentle pull the ribbon out.

* One cable runs from the mainboard to the daughterboard underneath the battery. Detach from both ends. With the battery removed, detach from keyboard shell, and set aside for the new keyboard shell.
* One cable runs between the touchpad and the mainboard. Detach from both ends, and also set aside.
* One cable runs between the keyboard and the mainboard. This one remains attached to the keyboard and only needs to be detached from the mainboard.
* One cable from the LCD attaches near the lid hinge. It should be just unplugged.

''Step 5'': Detach microphone, speakers, and antenna.

[[File:Pinebook_Pro_microphone_removed.jpg|300px|thumb|right|One of the Pinebook Pro microphones after removal]]

The speakers, microphone, and antenna don't have to be detached from the mainboard, but they need to be detached from the keyboard shell. The microphones are held in place by tape, and the speakers have sticky sides. The speakers are found obviously, but the microphones (two of) can be found between the battery and the hinge area. Each microphone can be carefully pulled/wedged out of its position by a small screwdriver or pick. The antenna, similar to the microphones, is found near the hinge area and to the top left of the battery.

''Step 6'': Remove mainboard and daughterboard.

At this point, the mainboard and daughterboards should be removed. When unscrewed (see Step 2) they should pull out fairly easily. Put them aside (including microphones and speakers if left attached.)

[[File:Pinebook_Pro_new_keyboard-all-boards-removed.jpg|300px|All boards removed]]

''Step 7'': Detach the LCD panel.

Step 2 didn't tell you, there are 6 more screws to remove here, 3 for each of the hinges. I recommend a PH1 bit for these screws. Unscrew these and the LCD panel will be able to be removed. You may have to jiggle or move the hinges for this. When detached, be sure to place the LCD panel such that the display is protected.

[[File:Pinebook_Pro_new_keyboard-detached-display.jpg|300px|Display detached]]
[[File:Pinebook_Pro_new_keyboard-detached-display2.jpg|300px|Display detached (front)]]

''Step 8'': Try Not To Break Your Touchpad, or, How I Learned To Love Things That Bend

'''NOTE This section really feels like you're going to break something.'''

The touchpad is glued to the keyboard shell and it's glued well. There are two places it is glued to. If you can, only the middle must be force-detached. You will think you're going to break it. Gently apply increasing force until the glue begins to detach (you will hear a crackle as it comes off), and continue very slowly until the whole thing is detached. This may take minutes due to that feeling you're going to break it.

I found it helpful to lift the top left plastic bit on the keyboard to unstick that portion of the touchpad, then push on the top left portion of the touchpad to unstick the rest of the touchpad.

[[File:Pinebook_Pro_new_keyboard-touchpad1.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad2.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad3.jpg|300px|Unmouting the touchpad]]

''Step 9'': Over the hill, touchpad goes into new shell.

In the new keyboard shell put the touchpad back where it was, hopefully the glue will remain sufficiently attached. If there is a glue issue, this guide unfortunately has no advice currently.

[[File:Pinebook_Pro_new_keyboard-install-touchpad.jpg|300px|Install the touchpad]]

''Step 10'': Reattach the LCD panel.

The LCD panel should slot back into the keyboard frame, the same way it came out. If the hinges were moved, they should be *very* *gently* closed such that the LCD panel and keyboard closed like normal for the remaining steps.

''Step 11'': Tape it out.

Move any tape from the old keyboard shell to the new one. These items protect the mainboard and daughterboard, and keep various wires in their right place. Some are grey and some are black. For tape that holds the speakers, microhones, or their cables in place, do not reattach yet.

''Step 12'': Board install.

Install the mainboard, the daughtboard, and their connecting ribbon cable. Be sure to put the boards in place, 2 large flat screws for the daughterboard, 3 large flat screws and one small screw for the mainboard, before attempting to place the ribbon.

''Step 13'': Microphone, speaker, and antenna install.

Reattach the microphones, antenna, and speakers to their respective areas, making sure that both are properly oriented - the speaker "out" faces up, and the microphone cables as connected must face up (these are opposite directions.)

''Step 14'': Reattach other ribbon cables.

NOTE: this would be a good time to attach/install the M.2 adapter board if that is desired. See elsewhere in this wiki for those instructions.

The LCD panel, keyboard and touchpad ribbon cables should be reattached. Make sure the flap is open, insert the ribbon into the slot (a portion of the cable will disappear), and push the flap down. The cable should not be easy to pull out.

''Step 15'': Reattach the battery, and final re-tape.

The battery should be installed with the 4 screws holding it in place, and the connector attached to the mainboard. Be sure to keep the two other cables remain unconnected. Ensure all wires and other tapes are held in place.

''Step 16'': Reattach the back panel.

Put the back panel back on, and reattach the 10 screws.

''Step 17'': If you changed from ISO to ANSI or from ANSI to ISO, you'll need to update your firmware now. See the links in Step 0 above.

== Touchpad (trackpad) ==
Documentation for the touchpad can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]]. It is the only component of the Pinebook Pro held in place with strong adhesive tape. Here are some of its features:

* 2 actuating buttons.

* multi-touch functionality.

* A matte finish that your finger can slide along easily.

* A reasonable size (96mm × 64mm; diagonal: 115.378mm or 4.542”).

=== Troubleshooting ===

If you are having trouble using 2 fingers to scroll or emulate the click of a mouse's right-button, then try these solutions:

* Update the firmware.

* Keep your 2 fingers spread apart rather than close together.

* Individual programs might need to be configured specially.

:* For smooth scrolling and gestures under X-Windows, ''Firefox'' should be launched with with the following environment variable assignment:

::: <code>MOZ_USE_XINPUT2=1</code>

* Experiment with other settings, via [[#X-Windows Configuration|X-Windows Configuration]] or some other system preferences; for example, you could disable double-finger scrolling, and instead enable scrolling by sliding one finger along the edge of the touchpad.

=== Firmware ===
The touchpad controller is connected to the keyboard controller. All touchpad events go through the keyboard controller and it's software, then to the keyboard controller's USB port. Note that the touchpad does have separate firmware, (which has to be written through the keyboard controller). The touchpad vendor’s firmware binary can be flashed from userspace using the following open source command-line utility:

* Kamil Trzciński’s [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater pinebook-pro-keyboard-updater].

Naturally, forks have begun to appear:

* Jack Humbert’s [https://github.com/jackhumbert/pinebook-pro-keyboard-updater fork]

* Dragan Simic’s [https://github.com/dragan-simic/pinebook-pro-keyboard-updater fork]. This one has recently delivered a much improved firmware from the vendor, which greatly improves the control of the cursor (see this [https://forum.pine64.org/showthread.php?tid=14531 thread] for discussion); before installing this update, consider resetting to the defaults any configuration of your touchpad.

'''Every Pinebook Pro produced before September 2021 should have its keyboard and touchpad firmware updated.'''

{{warning| DO NOT update the touchpad firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed. See [//old.reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Before updating ''any'' firmware, your Pinebook Pro should be either fully charged or, preferably, running from mains. This utility will be writing data to chips on the keyboard and touchpad, so a loss of power during any stage of the update can result in irrecoverable damage to your touchpad or keyboard.

The scripts ought to work on all OSs available for the Pinebook Pro. Some OSs may, however, require installation of relevant dependencies. The instructions below assume a Debian desktop. To install these dependencies, newer Pinebook Pro models that come with Manjaro will require a different command.

There are two keyboard versions of the Pinebook Pro: ISO and ANSI. You need to know which model you have prior to running the updater.
Firmware update steps for both models are listed below.

What you will need:

* Connection to WiFi (for getting dependencies).

* Your Pinebook Pro fully charged or running from mains power.

* An external USB keyboard & mouse (or access to the Pinebook Pro via SSH. Please note that for some configurations, the SSH service might not be available without first having logged in once; in this case, you will definitely want at least an external keyboard).

==== ISO Model ====

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 iso
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 iso
sudo poweroff # do not use 'reboot'
</pre>

==== ANSI Model ====

{{Hint| Note: Running step 1 on the ANSI keyboard model will make the keyboard and touchpad inaccessible until step 2 is run, so an external keyboard must be connected to complete the update on this model!}}

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 ansi
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 ansi
sudo poweroff # do not use 'reboot'
</pre>

When done, if some of the keys produce incorrect characters, please check your OS’s language settings. For ANSI users, the default OS may have shipped with English UK as the default language; you can change it to English US if desired.

==== Revised Firmware ====

In addition, you might consider using revised firmware data; this is one final step that should not require a reboot:

Step 3: '''ISO''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_iso.hex
</pre>

Step 3: '''ANSI''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_ansi.hex
</pre>

=== X-Windows Configuration ===
''Before making adjustments, consider updating the firmware; reset your adjustments before updating the firmware, so that your adjustments do not interfere with new functionality.''

Some forum members have found that an adjustment to X-Windows will allow finer motion in the touchpad. If you use the '''Synaptic''' mouse/touchpad driver, use this command to make the change live:
<pre>synclient MinSpeed=0.25</pre>
You may experiment with different settings, but 0.25 was tested as helping noticeably. 
 
To make the change persist across reboots, change the file <code>/etc/X11/xorg.conf</code> similar to below:
<pre> Section "InputClass"
Identifier "touchpad catchall"
Driver "synaptics"
MatchIsTouchpad "on"
MatchDevicePath "/dev/input/event*"
Option "MinSpeed" "0.25"
EndSection</pre>
The line <code>Option "MinSpeed" "0.25"</code> is the change. 
 
Another forum user built on the above settings a little, and have found these to be very good:
<pre>synclient MinSpeed=0.25
synclient TapButton1=1
synclient TapButton2=3
synclient TapButton3=2
synclient FingerLow=30
synclient PalmDetect=1
synclient VertScrollDelta=64
synclient HorizScrollDelta=64</pre>

<code>FingerLow</code> has the same value as 'FingerHigh' in one config (30). It is believed to help reduce mouse movement as you lift your finger, but it's unknown whether synaptic works like this.
You may find this config to be comfortable for daily use.
 

<code>TabButton</code> allows to just tab the touchpad instead of physically pressing it down (to get this click noise).

The <code>right mouse click</code> is emulated by tapping with two fingers on the touchpad. If you feel that this is not very responsive you can try this value:
<pre> synclient MaxTapTime=250 </pre>

Some users may encounter an issue with the mouse jumping when typing when using libinput driver (has not been test with synaptic) due to their hand hitting the touchpad which can be fixed by updating the xorg settings to disable it while typing. One can disable the touchpad while typing by setting the below option in the xorg config simliar to the previou example.

<pre>
Option "DisableWhileTyping" "on"
</pre>

The setting can be verified by using the xinput command to first list the devices and then listing the properties for the Touchpad device. Exact commands to check this have been omitted for save of brevity. If DisableWhileTyping is shown enabled but does not appear to be working the issue may be due to the fact that the keyboard is connected to a USB bus which causes it to be seen as a external keyboard. To resolve this one can add the config below which sets the keyboard to internal to ensure the DisableWhileTyping works properly.

You will need to edit <code>/etc/libinput/local-overrides.quirks</code> and add the following lines:
<pre>
[Serial Keyboards]
MatchUdevType=keyboard
MatchBus=usb
AttrKeyboardIntegration=internal
</pre>

Once X11 is restarted the new setting should now take effect and you will no longer be able to use the touchpad while typing which will mostly eliminate the mouse jumping issue.

== Power Supply ==
* Input Power: 5V DC @ 3A
* Mechanical: 3.5mm OD / 1.35mm ID, Barrel jack
* USB-C 5V, 15W PD quickcharge
* Only use one power input at a time, barrel jack OR USB-C

== LEDs ==
In total, there are four LEDs on the Pinebook Pro, three of which are placed in the top-left side of the keyboard, and one near the barrel port:

# The red LED next to the barrel port indicates charging, in three ways. First, it will illuminate steadily when either the factory power supply or a USB Type-C charger is connected to the Pinebook Pro, and the battery is getting charged. Second, if the battery is at 100%, the LED will remain turned off regardless of the connected power input; however, this is [https://forum.pine64.org/showthread.php?tid=10899 rather rarely achieved]. Third, this LED will flash at 0.5 Hz if there are any problems that prevent charging, such as the battery becoming too hot.
# The power indicator LED, above the keyboard, supports three different colors: green, amber and red. It is also capable of flashing to indicate eMMC activity. In the default Debian with MATE build, green LED means power and red means suspend (amber is unused).
# The green NumLock LED, above the keyboard.
# The green CapsLock LED, above the keyboard.

The NumLock and CapsLock LEDs serve their usual purposes on a keyboard, but they also have a secondary function. When the privacy switches get activated they blink to confirm that the switch has been activated.

== Webcam ==
{{Hint| You can use Cheese to test the Camera functionality}}
* Streaming video resolutions supported, (uncompressed):
** 320 x 240
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Still frame resolutions supported:
** 160 x 120
** 176 x 144
** 320 x 240
** 352 x 288
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200

== Microphones ==
While it has been said that some Pinebook Pro units contain only one microphone despite having two labeled microphone holes on the outer casing, other units do indeed contain two microphones. It is presently unclear which batches have either configuration; units from the initial community batch of 1000 units (following the initial 100) are believed to contain two, populating both labeled holes.

The wires leading to both microphones connect to the mainboard with a small white plastic connector, located directly adjacent to the ribbon cable attachment point for the keyboard interface.

'''Microphones not working?'''

If pavucontrol input doesn't show microphone activity try changing the [[Pinebook_Pro#Privacy_Switches|privacy switches]]. If the switches are in the correct place and microphone input isn't working you can run <code>alsamixer</code> from the command line, hit F6 and select the es8316, hit F4 to get to the capture screen, select the bar labeled ADC, increase the gain to 0dB, change the audio profile in pavucontrol to another one with input. Additionally you may want to modify ADC PGA to get the levels to where you want them. If that still hasn't fixed it you may want to check that the microphone connector is plugged in (see the section [[#Technical Reference|Technical Reference]]).

== Bluetooth and WiFi ==
[[File:PinebookPro_WirelessIC_Location.jpg|400px|thumb|right|The Pinebook Pro's AP6256 wireless module]]
===Hardware Overview===
The Pinebook Pro contains an AMPAK AP6256 wireless module to provide Wi-Fi (compliant to IEEE 802.11ac) and Bluetooth (compliant to Bluetooth SIG revision 5.0). The module contains a Broadcom transceiver IC, believed to be the BCM43456, as well as the support electronics needed to allow the Wi-Fi and Bluetooth modes to share a single antenna.

The wireless module interfaces with the Pinebook Pro’s system-on-chip using a combination of three interfaces: Bluetooth functionality is operated by serial UART and PCM, while the Wi-Fi component uses SDIO. It is unknown if the module’s Bluetooth capabilities are usable under operating systems that do not support SDIO.

The module’s RF antenna pin is exposed on the mainboard via a standard Hirose U.FL connector, where a coaxial feedline links it to a flexible adhesive antenna situated near the upper right corner of the Pinebook Pro’s battery. As the RF connector is fragile and easily damaged, it should be handled carefully during connection and disconnection, and should not be reconnected frequently.

===Issues===
Problems have been reported with the Wi-Fi transceiver’s reliability during extended periods of high throughput, especially on the 2.4 GHz band. While the cause of this has yet to be determined, switching to the 5 GHz band may improve stability.

Since the Bluetooth transceiver shares both its spectrum and antenna with 2.4 GHz Wi-Fi, simultaneous use of these modes may cause interference, especially when listening to audio over Bluetooth. If Bluetooth audio cuts out frequently, switching to the 5 GHz band – or deactivating Wi-Fi – may help.

===Wi-Fi Capabilities===
Wi-Fi on the Pinebook Pro is capable of reaching a maximum data transfer rate of approximately 433 megabits per second, using one spatial stream. The transceiver does not support multiple spatial streams or 160-MHz channel bandwidths.

The Wi-Fi transceiver supports the lower thirteen standard channels on the 2.4 GHz band, using a bandwidth of 20 MHz. At least twenty-four channels are supported on the 5 GHz band, spanning frequencies from 5180 to 5320 MHz, 5500 to 5720 MHz, and 5745 to 5825 MHz, with bandwidths of 20, 40, or 80 MHz.

Maximum reception sensitivity for both bands is approximately -92 dBm. The receiver can tolerate input intensities of no more than -20 dBm on the 2.4 GHz band, and no more than -30 dBm on the 5 GHz band. Maximum transmission power is approximately +15 dBm for either band, falling further to approximately +10 dBm at higher data transfer rates on the 5 GHz band.

With current available drivers and firmware, the Wi-Fi interface supports infrastructure, ad-hoc, and access-point modes with satisfactory reliability. Monitor mode is not presently supported. Wi-Fi Direct features may be available, but it is unclear how to make use of them under Linux.

Be aware that Linux userspace utilities, such as <code>iw</code>, may report inaccurate information about the capabilities of wireless devices. Parameter values derived from vendor datasheets, or direct testing, should be preferred to the outputs of hardware-querying tools.

===Bluetooth Capabilities===
Bluetooth data transfer speeds have an indicated maximum of 3 megabits per second, but it is unclear what practical data rates can be expected. Audio streaming over Bluetooth is functioning normally, as is networking. Bluetooth Low-Energy functions, such as interacting with Bluetooth beacons, have not yet been tested conclusively.

The Bluetooth transceiver supports all 79 channel allocations, spanning frequencies from 2402 MHz to 2480 MHz. Reception sensitivity is approximately -85 dBm, with a maximum tolerable reception intensity of -20 dBm. Bluetooth transmission power is limited to +10 dBm.

===Disabling Bluetooth===

To disable Bluetooth under Linux once:

sudo rfkill block bluetooth

To confirm if Bluetooth under Linux is disabled:

rfkill

To disable Bluetooth on boot (note: for distributions such as Manjaro XFCE see the step below):

sudo systemctl enable rfkill-block@bluetooth

To disable Bluetooth on certain distributions, such as Manjaro XFCE, right click on the Bluetooth panel icon, select plugins, then PowerManager, then configuration and then deselect the auto power on option

== LCD Panel ==
* Model: BOE NV140FHM-N49
* 14.0" (35.56 cm) diagonal size
* 1920x1080 resolution
* 60 Hz refresh rate
* IPS technology
* 1000:1 contrast
* 250 nit brightness
* 63% sRGB coverage
* 6-bit color
* 30-pin eDP connection

Some people have tested hardware video decode using the following;

<pre>ffmpeg -benchmark -c:v h264_rkmpp -i file.mp4 -f null -</pre>

== External ports list ==
Here are a list of the external ports. See [[Pinebook_Pro#Expansion_Ports|Technical Reference - Expansion Ports]] for port specifications.
* Left side
** Barrel jack for power, (with LED)
** USB 3, Type A
** USB 3, Type C
* Right side
** USB 2, Type A
** Standard headset jack
** MicroSD card slot

== Using the UART ==
[[File:PinePhone_Serial_Cable.png|400px|thumb|right|Pinout of the serial adapter. Swapping the tx and rx around from this also works and is more traditional. See the official [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pine64 document].]]

UART output is enabled by flipping the UART switch to the ON position (item 9). To do so you need to remove the Pinebook Pro's bottom cover - please follow [[Pinebook_Pro#Disassembly_and_Reassembly|proper disassembly and reassembly protocol]]. The OFF position is towards the touchpad, the ON position is towards the display hinges.

With the UART switch in the ON position, console is relayed via the audiojack and the laptop's sound is turned OFF. Please ensure that you are using a 3.3 V interface (such as the CH340, FTDI-232R, or PL2303, which are sold in both 3.3 V and 5 V variants) to avoid damage to the CPU. Older version of the serial console cable sold by Pine64 uses wrong voltage level and should not be used; see [https://forum.pine64.org/showthread.php?tid=9367 this forum thread] for further information. Recent version of the same cable uses the right voltage level.

Insert the USB plug of the cable into an open USB port on the machine which will monitor, ensuring that the audio jack of the serial cable is be fully inserted into the Pinebook Pro audio port. Run the following in a terminal:

<code>
$ lsusb
</code>

you should find a line similar to this:

<code>
Bus 001 Device 058: ID 1a86:7523 QinHeng Electronics HL-340 USB-Serial adapter
</code>

Serial output should now be accessible using screen, picocom or minicom (and others).
Examples:

<code>
screen /dev/ttyUSB0 1500000

picocom /dev/ttyUSB0 -b 1500000

minicom -D /dev/ttyUSB0 -b 1500000</code>

Old versions of U-Boot do not use the UART for console output. <strike>The console function is activated by the Linux kernel. Thus, if you use a non-Pinebook Pro Linux distro and want the UART as a console, you have to manually enable it.</strike>

== Using the optional NVMe adapter ==
The optional NVMe adapter allows the use of M.2 cards that support the NVMe standard, (but not SATA standard). The optional NVMe M.2 adapter supports '''M''' & '''M'''+'''B''' keyed devices, in both 2242 & 2280 physical sizes, the most common ones available. In addition, 2230 & 2260 are also supported, though NVMe devices that use those sizes are rare.

Once you have fitted and tested your NVMe drive, please add a note to this page [[Pinebook Pro Hardware Accessory Compatibility]] to help build a list of tried and tested devices.

Please see [[Pinebook Pro Troubleshooting Guide#NVMe SSD issues|a separate section]] that describes reported issues with the NVMe drives in PineBook Pro.

=== Installing the adapter ===
The V2.1-2019-0809 SSD adapter that shipped with the initial Pinebook Pro batches had significant issues. A repair kit will be shipped to address those issues.
(If necessary, it can be modified to work. There is [https://forum.pine64.org/showthread.php?tid=8322&pid=52700#pid52700 an unofficial tutorial on the forums] describing these modifications.)

The updated SSD adapter, labeled V2-2019-1107, takes into account the prior problems with touchpad interference. New orders as of Feb. 22nd, 2020 will be the updated adapter.

This is the link to the Pinebook Pro accessories in the store: [[https://pine64.com/?v=0446c16e2e66]]

Actual installation instructions are a work in progress. Unofficial instructions for installing V2-2019-1107 can be found [https://eli.gladman.cc/blog/2020/06/23/pine-book-pro-nvme.html here].

=== Post NVMe install power limiting ===
Some NVMe SSDs allow reducing the maximum amount of power. Doing so may reduce the speed, but it may be needed in the Pinebook Pro to both improve reliability on battery: Some NVME may be stable with default settings when runnning on AC power but cause frequent kernel panics (system freeze with power LED blinking red/green) when running on battery. Reducing NVME power drain solves this in some cases. And reducing power used gives better battery life.
Here are the commands to obtain and change the power settings. The package 'nvme-cli' is required to run these commands. The example shows how to find the available power states, and then sets it to the lowest, non-standby setting, (which is 3.8 watts for the device shown);

<pre>$ sudo nvme id-ctrl /dev/nvme0
NVME Identify Controller:
...
ps 0 : mp:9.00W operational enlat:0 exlat:0 rrt:0 rrl:0
rwt:0 rwl:0 idle_power:- active_power:-
ps 1 : mp:4.60W operational enlat:0 exlat:0 rrt:1 rrl:1
rwt:1 rwl:1 idle_power:- active_power:-
ps 2 : mp:3.80W operational enlat:0 exlat:0 rrt:2 rrl:2
rwt:2 rwl:2 idle_power:- active_power:-
ps 3 : mp:0.0450W non-operational enlat:2000 exlat:2000 rrt:3 rrl:3
rwt:3 rwl:3 idle_power:- active_power:-
ps 4 : mp:0.0040W non-operational enlat:6000 exlat:8000 rrt:4 rrl:4
rwt:4 rwl:4 idle_power:- active_power:-

$ sudo nvme get-feature /dev/nvme0 -f 2
get-feature:0x2 (Power Management), Current value:00000000
$ sudo nvme set-feature /dev/nvme0 -f 2 -v 2 -s
set-feature:02 (Power Management), value:0x000002</pre>

Some NVMe SSDs don't appear to allow saving the setting with "-s" option. In those cases, leave off the "-s" and use a startup script to set the non-default power state at boot. 
If you want to test performance without saving the new power setting semi-permanantly, then leave off the "-s" option. 
 

On systemd based distros like Manjaro, a non-defaut power state for an NVME can be set using a systemd service. This is useful in cases where the NVME drive does not save the power state and/or uses APST.

An example systemd service, nvme-throttle.service, is shown below:

<pre>
[Unit]
Description=Throttles NVME to lesss power hungry mode
After=suspend.target hibernate.target hybrid-sleep.target suspend-then-hibernate.target

[Service]
Type=oneshot
ExecStart=/usr/bin/nvme set-feature /dev/nvme0 -f 2 -v 1

[Install]
WantedBy=multi-user.target suspend.target hibernate.target hybrid-sleep.target suspend-then-hibernate.target
</pre>

Here the value after "-v" is the maximum power state that you want your SSD to use. 
 
This will be executed at system startup, and every time your system exits any suspend mode that might reset the SSD to default values. 

This file needs to be placed in the /etc/systemd/system directory. Afterwards, to activate the service, run: 

<pre>
systemctl daemon-reload
systemctl enable --now nvme-throttle.service
</pre>

 
There is another power saving feature for NVMes, APST, (Autonomous Power State Transitions). This performs the power saving & transitions based on usage. To check if you have a NVMe SSD with this feature;
<pre>$ sudo nvme get-feature -f 0x0c -H /dev/nvme0</pre>
Information for this feature, (on a Pinebook Pro), is a work in progress. It is enabled by default in latest Manjaro kernels and reported to work.
On some NVME SSDS (WD), APST is compatible with limiting NVME maximum power : APST will work and not exceed maximum power state defined using
previous method.

=== Using as data drive ===
As long as the kernel in use has both the PCIe and NVMe drivers, you should be able to use a NVMe drive as a data drive. It can automatically mount when booting from either the eMMC or an SD card. This applies to Linux, FreeBSD, and Chromium, using the normal partitioning and file system creation tools. Android requires testing.

=== Using as OS root drive ===
The SoC does not include the NVMe boot code, so the NVMe is not in the SoC's boot order. However, using the [https://github.com/mrfixit2001/updates_repo/blob/v1.1/pinebook/filesystem/mrfixit_update.sh U-Boot update script] from the mrfixit2001 Debian or [https://pastebin.com/raw/EeK074XB Arglebargle's modified script], and [https://github.com/pcm720/rockchip-u-boot/releases the modified u-boot images] provided by forum user pcm720, you can now add support to boot from an NVMe drive. Binary images are useable with SD, eMMC, and [[Pinebook_Pro_SPI|SPI flash]]. For OS images using the mainline kernel, there are a few variants of U-Boot available that also support NVMe as the OS drive. Though these may require writing the U-Boot to the SPI flash for proper use of the NVMe as the OS drive.

The current boot order, per last testing, for this modified U-Boot is:
*MicroSD
*eMMC
*NVMe

For more information, please refer to [https://forum.pine64.org/showthread.php?tid=8439&pid=53764#pid53764 the forum post.]

It is also possible to initially boot off an eMMC or SD card, then transfer to a root file system on the NVMe. Currently, it is necessary to have the U-Boot code on an eMMC or SD card. (A forum member [https://forum.pine64.org/showthread.php?tid=8439 posted here] about using a modified version of U-Boot with NVMe drivers, that uses <code>/boot</code> and <code>/</code> off the NVMe drive. So this may change in the future.)

Please see [[Pinebook_Pro#Bootable Storage|Bootable Storage]].

== Caring for the PineBook Pro ==
=== Bypass Cables ===
The mainboard features two (disconnected by default) bypass cables that are only to be used with the battery disconnected. The female (10) male (6) ends of the bypass cables can be connected to provide power to the mainboard if you need to run the laptop without a battery. Please refer to this [https://files.pine64.org/doc/PinebookPro/PinebookPro_Engineering_Notice.pdf engineering notice].

'''Note that despite the bypass cable being a two conductor cable, it is only used as one. Both wires being soldered together on either side is normal!'''

{{warning|Do not connect the bypass cables with the battery connected. Using the bypass cables with the battery connected can permanently damage the computer.}}

=== Pinebook Service Step-by-Step Guides ===

Under [[Pinebook_Service_Step_by_Step_Guides|Service Guides for Pinebook]] you can find instructions guides concerning disassembly of:

* The installation process on Pinebook Pro similar to 14" Pinebook
* The installation process is the reverse order of removal guide:
** 14″ Pinebook Lithium Battery Pack Removal Guide
** 14″ Pinebook LCD Panel Screen Removal Guide
** 14″ Pinebook eMMC Module Removal Guide

== Using the SPI flash device ==

See [[Pinebook Pro SPI]] for details.

The Pinebook Pro comes with a 128Mbit, (16MByte), flash device suitable for initial boot target, to store the bootloader. The SoC used on the Pinebook Pro boots from this SPI flash device first, before eMMC or SD card. At present, April 19, 2020, the Pinebook Pros ship without anything programmed in the SPI flash device. So the SoC moves on to the next potential boot device, the eMMC. ARM/ARM64 computers do not have a standardized BIOS, yet.

Here is some information on using the SPI flash device:

* You need the kernel built with SPI flash device support, which will supply a device similar to: code>/dev/mtd0</code>
* The Linux package below, will need to be available: <code>mtd-utils</code>
* You can then use this program from the package to write the SPI device: <code>flashcp <filename> /dev/mtd0</code>

Even if you need to recover from a defective bootloader written to the SPI flash, you can simply short pin 6 of the SPI flash to GND and boot. This will render the SoC bootrom unable to read from the SPI flash and have it fall back to reading the bootloader from other boot media like the eMMC or Micro SD card.

The procedures described above are a lot less risky than attaching an external SPI flasher and do not require any additional hardware. At present, April 19th, 2020, there is no good bootloader image to flash into the SPI flash device. This is expected to change, as there are people working on issue.

= Software tuning guide =
Details on how to get the most out of a Pinebook Pro & its RK3399 SoC.

== Customizing the Pinebook Pro's default Manjaro KDE system ==
=== Watching DRM content (Netflix, etc.) ===
Most paid online streaming services use Widevine DRM to make their content more difficult to pirate. Widevine is not directly supported on Manjaro KDE, however it is still possible to watch DRM content via the "chromium-docker" package which downloads a 32-bit ARM container and installs Chromium with Widevine inside of that. While not space-efficient, or efficient in general, it's the recommended solution for watching this content on your Pinebook Pro. You can install this package with:
<pre>sudo pacman -Sy chromium-docker</pre>

=== Checking GPU capabilities ===
To see what versions of OpenGL and OpenGL ES are supported by the Pinebook Pro, what driver is in use, and what version of the driver is loaded, install the "mesa-demos" package with:
<pre>sudo pacman -Sy mesa-demos</pre>
And then run:
<pre>glxinfo | grep OpenGL</pre>
This will give detailed information about your graphics card and driver, useful for debugging.

=== Better GPU compatibility and performance ===
For better graphics performance, you may install the "mesa-git" package, built and supplied in the Manjaro ARM repos. This lets you bring in the latest features, optimizations, and bugfixes for the graphics driver used by the Pinebook Pro. Installation is as simple as:
<pre>pacman -Sy mesa-git</pre>
Then you may reboot to load the newer driver.

With Mesa 20.2 there is no longer much reason to use this over the standard mesa package, and applications may occasionally break with mesa-git.

[https://docs.mesa3d.org/bugs.html Reporting bugs] to the Mesa project will help make sure any problems are quickly fixed.

=== OpenGL 3.3 support ===
By default, with the current state of the Panfrost GPU driver, the Pinebook Pro supports OpenGL 2.1 and OpenGL ES 3.0. If you want to use OpenGL 3.3, you need to set the system-wide environment variable, open the '''/etc/environment''' file with:
<pre>kate /etc/environment</pre>
And then at the bottom of the file, on a new line, add:
<pre>PAN_MESA_DEBUG="gl3"</pre>
Then save the file, entering your password when prompted, and reboot the system. When you check your GPU capabilities, it should report OpenGL 3.3 and applications that rely on it should function properly. Note that GL 3.3 support is incomplete and some rendering features do not work yet, notably geometry shaders.

=== Install Anbox on Pinebook Pro Manjaro 20.10 ===
[https://www.youtube.com/watch?v=EU8_Q11dATs Youtube video on installing Anbox on Pienbook Pro Manjaro Build 20.10 by LivingLinux]

== Customizing the Pinebook Pro's previously-default Debian system ==
Here are some hints on what you can do to customize the Pinebook Pro's previous factory image (aka [https://github.com/mrfixit2001/debian_desktop mrfixit2001 debian build])

=== Initial user changes, password, name, etc ===
When you first get your Pinebook Pro, you should consider setting strong passwords and making the default account your own.

* Reboot (this is just to ensure all background processes belong to the user are not running... there are other ways to achieve this but this way is easy)
* Once the machine reboots press Alt-Ctrl-F1 to bring up a text terminal
* Login as root (login: root, password: root)
* Set a strong password for the root user using the following command and it's prompts:
<pre># passwd (and follow prompts)</pre>
* Rename the rock user to your prefered username (replace myself with whatever you like):
<pre># usermod -l myself -d /home/myself -m rock</pre>
* Rename the rock group to match your preferred username:
<pre># groupmod -n myself rock</pre>
* Put your name in the account, (replace "John A Doe" with your name):
<pre># chfn -f "John A Doe" myself</pre>
* Set a strong password for the normal user:
<pre># passwd myself</pre>
* Log out of the text terminal:
<pre># logout</pre>
* Press Alt-Ctrl-F7 to go back to the login screen and then login as the normal user
* Open text terminal to fix login error: "Configured directory for incoming files does not exist";
<pre>$ blueman-services</pre>
Select "Transfer" tab and set "Incoming Folder" to myself
OR
If adduser is in distro, this is MUCH easier
sudo adduser $USER ,, fill out requested data
Then,, sudo adduser $USER $GROUP,,, 1 group at a time
To see which groups to add,,, id $USER, id rock

=== Changing the default hostname ===
Debian 9 has a command to allow you to change the hostname. You can see the current settings using;
<pre>$ sudo hostnamectl
Static hostname: Debian-Desktop
Icon name: computer
Machine ID: dccbddccbdccbdccbdccbdccbdccbccb
Boot ID: ea99ea99ea99ea99ea99ea99ea99ea99
Operating System: Debian GNU/Linux 9 (stretch)
Kernel: Linux 4.4.210
Architecture: arm64</pre>
To change, use this, (with "My_Hostname" used as the example);
<pre>$ sudo hostnamectl set-hostname My_Hostname</pre>
Whence done, you can re-verify using the first example.

Then you should backup and edit your <code>/etc/hosts</code> entry's name;
<pre>$ sudo cp -p /etc/hosts /etc/hosts.`date +%Y%m%d`
$ sudo vi /etc/hosts
127.0.0.1 localhost
127.0.0.1 My_Hostname
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
127.0.1.1 linaro-alip</pre>

=== Disable Chromium browser's prompt for passphrase & password storage ===

Perform the following steps:

* On the tool bar, hover over the Chromium icon
* Using the right mouse button, select '''Properties'''
* In the '''Command:''' line section, add <code>--password-store=basic</code> before the <code>%U</code>
* Use the '''x Close''' button to save the change
This will of course, use basic password storage, meaning any saved passwords are not encrypted. Perfectly fine if you never use password storage.

=== Changing the boot splash picture ===

The default boot splash picture can be replaced using the following instructions:

* Install '''ImageMagick''' which will do the conversion
<pre>$ sudo apt-get install imagemagick</pre>
* Create a 1920 x 1080 picture. For the best results, use a PNG image (It supports lossless compression).
* From the directory in which your new image is stored run the following commands
* Convert your image to the bootsplash raw format using imagemagick convert.
<pre>$ convert yoursplashimage.png -separate +channel -swap 0,2 -combine -colorspace sRGB RGBO:splash.fb</pre>
* Create a backup copy of your current splash screen
<pre>$ sudo cp /usr/share/backgrounds/splash.fb /usr/share/backgrounds/splash_original.fb</pre>
* Copy your new splash screen into place
<pre>$ sudo cp splash.fb /usr/share/backgrounds/splash.fb</pre>
* Set the correct permissions on the splash.fb file
<pre>$ sudo chmod 644 /usr/share/backgrounds/splash.fb</pre>
* If you do not want to see kernel console text messages, make sure you don't have '''Plymouth''' installed

=== Watching Amazon Prime videos with Chromium ===
When you create a new user, it will be necessary to launch the Chromium browswer with a specific user agent like below;
<pre>chromium-browser --user-agent="Mozilla/5.0 (X11; CrOS armv7l 6946.63.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36"</pre>
There may be more tweaks needed.

=== Enabling text boot time messages ===

By default, most Linux distros have a boot screen with a picture. To see all the boot time messages, use one of the following;

==== Debian ====
* Backup and edit the U-Boot configuration file:

cp -p /etc/default/u-boot /etc/default/u-boot.`date +%Y%m%d`
chmod a-w /etc/default/u-boot.`date +%Y%m%d`
vi /etc/default/u-boot

Remove the '''quiet''' and '''splash''' parameters. Leave everything else alone.

* Update the U-Boot configuration:

u-boot-update

* Test and verify you get what you think you should be seeing.

==== Manjaro ====
* Backup and edit the U-Boot configuration file:

cp -p /boot/extlinux/extlinux.conf /boot/extlinux/extlinux.conf.`date +%Y%m%d`
chmod a-w /boot/extlinux/extlinux.conf.`date +%Y%m%d`
vi /boot/extlinux/extlinux.conf

* Change '''console=ttyS2,1500000''' to '''console=tty1'''
* Remove the '''bootsplash.bootfile''' option and it's parameter.
* You can add verbose logging by appending '''ignore_loglevel''' to the line where boot splash was.
* Leave everything else alone.
* Test and verify you get what you think you should be seeing.

== Improving readability ==

Some people find that a 14" LCD screen with 1080p, (1920 x 1080), has text and icons a bit too small. There are things you can do to make the screen easier to use and read. 
* Increase the font size
* Use a font with more pronounced features
* Increase the various window manager sizes (e.g. increase the height of the tool bar)
* Change the color scheme to be easier on the eyes. Higher contrast can help usability.
* Change the window manager's decorations (e.g. use larger icons)
* Use a workspace manager, with one application per workspace
* When at home or office, use an external monitor
* Change the X-Windows DPI. One such method that someone used successfully, is: <blockquote><code>echo "Xft.dpi: 150" >> ~/.Xresources</code></blockquote>Change the 150 as desired to get the size adjustment you want.
 
However, do not change the resolution of the LCD screen, otherwise you may end up with a blank / black screen. If that happens, see this troubleshooting section for the fix: 
[[Pinebook_Pro#After_changing_builtin_LCD_resolution.2C_blank_screen|Blank screen after changing builtin LCD resolution]]

== Chromium tweaks ==

=== Flags ===

From the [https://github.com/mrfixit2001/updates_repo/blob/v1.8/pinebook/filesystem/default official Debian image]:

<pre>
--disable-low-res-tiling \
--num-raster-threads=6 \
--profiler-timing=0 \
--disable-composited-antialiasing \
--test-type \
--show-component-extension-options \
--ignore-gpu-blacklist \
--use-gl=egl \
--ppapi-flash-path=/usr/lib/chromium-browser/pepper/libpepflashplayer.so \
--ppapi-flash-version=32.0.0.255 \
--enable-pinch \
--flag-switches-begin \
--enable-gpu-rasterization \
--enable-oop-rasterization \
--flag-switches-end
</pre>

Note that in some cases, this may also decrease performance substantially, as observed when using these flags on the Manjaro KDE desktop. Feel free to experiment to find what is smoothest for you personally.

== gVim has performance issue ==
It appears that using GTK3 can cause very slow scrolling, while Vim in a terminal window works fine. 
Simply revert back to using GTK2, (how to do so is somewhat Linux distro-specific).

Another solution may be to run gVim with

GDK_RENDERING=image

environment variable set. It seems that this improves the performance by reverting back to software-only rendering.

== Kernel options ==
Here are some Pinebook Pro & its RK3399 SoC Linux specific options. If kernel version, (or version range specific), it should list that information in the description.

To see if a specific feature is enabled in the current kernel, you can use something like this;

<pre>
$ zgrep -i rockchip_pcie /proc/config.gz
# CONFIG_ROCKCHIP_PCIE_DMA_OBJ is not set
CONFIG_PHY_ROCKCHIP_PCIE=m
</pre>
If it's listed as <code>=m</code>, then it's a module. You can see if the module is loaded with;
<pre>
$ lsmod | grep -i rockchip_pcie
phy_rockchip_pcie 16384 0
</pre>
Note modules are not loaded until needed. Thus, we sometimes check the kernel configuration instead to see if a feature is configured first, then see if it's a module.

=== Hardware video decoding ===
Here is a method to check for hardware video decoding by the VPU. There are special Linux kernel modules that perform this function. 
Older systems, such as the previously-default Debian desktop, use the Rockchip-supplied kernel module <code>rk-vcodec</code>. To check, something like this can be used:
<pre>
$ lsmod | grep rk-vcodec
or
$ zgrep RK_VCODEC /proc/config.gz
CONFIG_RK_VCODEC=y
</pre>
Note that in the above example, the Rockchip video CODEC is not built as a module, but included into the kernel. Thus, it does not show up in the list modules check. 
 

Newer systems may use a different option as in the configuration below:
<pre>
$ zgrep HANTRO /proc/config.gz
CONFIG_VIDEO_HANTRO=m
CONFIG_VIDEO_HANTRO_ROCKCHIP=y
</pre>

= Troubleshooting guide =

Do not panic if something goes wrong or in an unexpected way. Instead, stop and consider carefully how to undo something, or how to redo it. This particularly applies when flashing a new operating system, or flashing new firmware to the keyboard or touchpad. If everything fails, consider reporting the issue on the forums, with as many relevant details as available.

Please, have a look at the [[Pinebook Pro Troubleshooting Guide]], which details a number of issues you may encounter.

= Hardware/Accessory Compatibility =
Please contribute to the [[Pinebook Pro Hardware Accessory Compatibility|hardware/accessory compatibility page]], which lists the status of hardware tested with the Pinebook Pro. Available hardware categories include the following:

* [[Pinebook Pro Hardware Accessory Compatibility#NVMe SSD drives|NVMe SSD drives]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB hardware|USB hardware]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB C alternate mode DP|USB-C alternate mode DP]]
* [[Pinebook Pro Hardware Accessory Compatibility#Other hardware|Other hardware]]

= Technical Reference =
== Disassembly and Reassembly ==
[[File:Standoffs.png|400px|thumb|right|Pinebook Screw stand-offs correct placement and location]]

[[File:Hinges_cover_removed_1.jpeg|300px|thumb|right|Hinge area of the Pinebook Pro lid with the cover removed]]
[[File:Hinges_cover_removed_2.jpeg|300px|thumb|right|Close-up of a Pinebook Pro lid hinge]]

There are a few '''mandatory''' precautions to be taken:

* Do not open the laptop by lifting the lid while the Pinebook Pro bottom cover is removed - this can cause structural damage to the hinges and/or other plastic components of the chassis such as the IO port cut-outs.
* When removing the back cover plate, *do not, under any circumstances, slide your fingertips between the metal shell and the plastic frame!* The back cover plate edges are sharp, and when combined with the pressure and movement generated from, specifically, attempting to slide the tips of your fingers along the bottom edge of the plate along the lid-hinge, they *will* slice open the tips of your fingers like a knife.
* When removing the back cover plate, use care to avoid damaging the speakers. They can be stuck to the back cover with double-sided tape, and the thin wires are very delicate. Newer Pinebook Pro laptops (as of the May 2021 batch, and perhaps earlier) seem to lack the double-sided tape to the rear cover, instead opting for tape or glue that makes them stick to the front cover. Nevertheless, be gentle when removing the back cover.

[[File:PinebookProScrewGuide.png|400px|thumb|right|Pinebook Pro external screws (this particular unit has suffered damage on screw (4)L)]]

When disassembling the laptop make sure that it is powered off and folded closed. To remove the bottom cover of the Pinebook Pro, first remove the ten (10) Phillips head screws that hold the bottom section of the laptop in place. There are four (4) short screws along the front edge, and six (6) long screws along the 3 remaining sides. Remove the cover from the back where the hinges are situated by lifting it up and away from the rest of the chassis. The aluminum case is held on only by screws. There are no plastic snaps, and the shell should pull away without any effort. If you experience any resistance at all stop and ensure all ten (10) screws are accounted for.

During reassembly, make sure that the back-screw standoffs are in place and seated correctly. Before replacing the aluminum back-plate, ensure that the speakers are properly seated by pressing gently on the hard plastic edge of the speaker module. Slide the bottom section into place so it meets the front lip of the keyboard section. Secure the front section (where the touchpad is located) in place using the short screws in the front left and right corners. Then proceed to pop in the bottom panel into place. Secure the bottom section (where hinges are located) by screwing in the left and right corners. Then screw in the remaining screws and run your finger though the rim on the chassis to make sure its fitted correctly. Note that the front uses the remaining 4 short screws.

The screws are small and should only be finger tight. Too much force will strip the threads. If after installing screws the back cover plate has not seated properly on one side (which may be caused by the aforementioned misseating of the speakers), open the display and hold the base on either side of the keyboard and gently flex the base with both hands in opposing directions. Once the side pops further in, then recheck the screws on that side. If it does not pop back in, re-open the machine and check for misseated components.

A basic 3D model to print replacement standoffs for the back cover screws is [https://www.thingiverse.com/thing:4226648 available on Thingiverse], until the official drawings or 3D models are made available.

====Display Disassembly====
It is not recommended to adjust the position of the lid when the bottom cover is removed, because the bottom cover provides structural strength, so the lid should be open fully as the first step, before starting any disassembly of the laptop. After opening the lid, remove the bottom cover by following the instruction found in the section above. Alternatively, you can keep the lid closed and remove the screws that hold the hinges to the main laptop body, as described in [[Pinebook Service Step by Step Guides]].

Parts of the hinge mechanism, as well as the screws that hold the hinges to the lid, are hidden behind an elongated plactic U-shaped cover that snaps in place using latches. Use a dedicated plastic prying tool or a guitar pick to gently pry the cover and remove it, starting from the outer edge. Once you pry the cover to a certain extent, it should be possible to remove it fully using only your hands. The U-shaped cover is rather sturdy, but still be careful not to break or bend it.

There are two small screws hidden underneath the two small rubber nubs on the upper part of the screen bezel, so first gently remove the nubs and then remove the screws. The screen bezel is held in place with a combination of latches and some adhesive tape, which is there to prevent dust ingress. The adhesive isn't very strong, and the bezel is capable of flexing back into shape after being twisted to a certain extent. There is more adhesive on the bottom part of the screen bezel, so be more careful while prying that section apart. Use the same prying tool that you used for the U-shaped cover, and work it around the outer edges of the screen bezel.

== Internal Layout ==

=== Main chips ===
* RK3399 system-on-chip (1)
* LPDDR4 SDRAM (21)
* SPI NOR flash memory (29)
* eMMC flash memory (26)
* WiFi/BT module (27)

=== Mainboard Switches and Buttons ===
There are two switches on the main board: disabling the eMMC (24), and enabling UART (9) via headphone jack.

The Reset and Recovery buttons (28): the reset button performs an immediate reset of the laptop. The Recovery button is used to place the device in maskrom mode; this mode allows flashing eMMC using Rockchip tools (e.g. rkflashtools).

[[File:PBPL_S.jpg]]

=== Key Internal Parts ===
{| class="wikitable"
|+ Numbered parts classification and description
! Number
! Type
! Descriptor
|-
! scope=row | 1
| Component || RK3399 System-On-Chip
|-
! scope=row | 2
| Socket || PCIe x4 slot for optional NVMe adapter
|-
! scope=row | 3
| Socket || Speakers socket
|-
! scope=row | 4
| Socket || Touchpad socket
|-
! scope=row | 5
| Component || Left speaker
|-
! scope=row | 6
| Connector || Power bridge connector
|-
! scope=row | 7
| Socket || Keyboard Socket
|-
! scope=row | 8
| Component || Optional NVMe SSD adapter
|-
! scope=row | 9
| Switch || UART/Audio switch - outputs UART via headphone jack
|-
! scope=row | 10
| Socket || Power bridge socket
|-
! scope=row | 11
| Socket || Battery socket
|-
! scope=row | 12
| Component || Touchpad
|-
! scope=row | 13
| Component || Battery
|-
! scope=row | 14
| Component || Right speaker
|-
! scope=row | 15
| Socket || MicroSD card slot
|-
! scope=row | 16
| Socket || Headphone / UART jack
|-
! scope=row | 17
| Socket || USB 2.0 Type A
|-
! scope=row | 18
| Socket || Daughterboard-to-mainboard ribbon cable socket
|-
! scope=row | 19
| Cable || Daughterboard-to-mainboard ribbon cable
|-
! scope=row | 20
| Component || microphone
|-
! scope=row | 21
| Component || LPDDR4 RAM
|-
! scope=row | 22
| Socket || Mainboard-to-daughterboard ribbon cable socket
|-
! scope=row | 23
| Socket || Microphone socket
|-
! scope=row | 24
| Switch || Switch to hardware disable eMMC
|-
! scope=row | 25
| Antenna || BT/WiFI antenna
|-
! scope=row | 26
| Component || eMMC flash memory module
|-
! scope=row | 27
| Component ||BT/WiFi module chip
|-
! scope=row | 28
| Buttons || Reset and recovery buttons
|-
! scope=row | 29
| Component || SPI flash storage
|-
! scope=row | 30
| Socket || eDP LCD socket
|-
! scope=row | 31
| Socket || Power in barrel socket
|-
! scope=row | 32
| Socket || USB 3.0 Type A
|-
! scope=row | 33
| Socket || USB 3.0 Type C
|}

=== Smallboard detailed picture ===

[[File:Pinebook_pro_smallboard.jpg]]

== Bootable Storage ==

=== Boot sequence details ===
The RK3399's mask 32KB ROM boot code looks for the next stage of code at byte off-set 32768, (sector 64 if using 512 byte sectors). This is where U-Boot code would reside on any media that is bootable. 
[[RK3399_boot_sequence|RK3399 boot sequence]]

=== Boot devices ===

The Pinebook Pro is capable of booting from eMMC, USB 2.0, USB 3.0, or an SD card. It cannot boot from USB-C. The boot order of the hard-coded ROM of its RK3399 SoC is: SPI NOR, eMMC, SD, USB OTG.

At this time, the Pinebook Pro ships with a Manjaro + KDE build with [https://www.denx.de/wiki/U-Boot/ u-boot] on the eMMC. Its boot order is: SD, USB, then eMMC.

(An update has been pushed for the older Debian + MATE build that improves compatibility with booting other OSes from an SD card. In order to update, fully charge the battery, establish an internet connection, click the update icon in the toolbar, and then reboot your Pinebook Pro. Please see [https://forum.pine64.org/showthread.php?tid=7830 this log] for details.)

Please note that PCIe, the interface used for NVMe SSD on the Pinebook Pro, is not bootable on the RK3399 and therefore is not a part of the boot hierarchy. It is possible to run the desired OS from NVMe by pointing extlinux on the eMMC to rootfs on the SSD. This requires uboot, the Kernel image, DTB, and extlinux.conf
in a /boot partition on the eMMC.

=== eMMC information ===
The eMMC appears to be hot-pluggable. This can be useful if trying to recover data or a broken install. Best practice is probably to turn the eMMC switch to off position before changing modules. Note that the enable/disable label on the silkscreen is incorrect on some board revisions (known bad on v2.1).

The eMMC storage will show up as multiple block devices:
*mmcblk1boot0 - eMMC standard boot0 partition, may be 4MB
*mmcblk1boot1 - eMMC standard boot1 partition, may be 4MB
*mmcblk1rpmb - eMMC standard secure data partition, may be 16MB
*mmcblk1 - This block contains the user areas

Only the last is usable as regular storage device in the Pinebook Pro.
The device number of "1" shown above may vary, depending on kernel.

If the eMMC module is enabled after boot from an SD card, you can detect this change with the following commands as user "root";
<pre>
echo fe330000.mmc >/sys/bus/platform/drivers/sdhci-arasan/unbind
echo fe330000.mmc >/sys/bus/platform/drivers/sdhci-arasan/bind
</pre>

(Note: with the device trees coming with older kernels (Linux < 5.11), the device name may be fe330000.sdhci instead of fe330000.mmc)

== Case Dimensions and Data ==
* Dimensions: 329mm x 220mm x 12mm (WxDxH)
* Weight: 1.26Kg
* Screws
** Philips head type screws
** M2 flat head machine screws (measurements in mm)
** 4 x Small screws (used along the front edge): Head - 3.44, Thread Diameter - 1.97, Thread Length - 2.1, Overall length - 3.05
** 6 x Large screws: Head - 3.44, Thread Diameter - 1.97, Thread Length - 4.41, Overall Length - 5.85
* Rubber Feet
** 18mm diameter
** 3mm height
** Dome shaped

== SoC and Memory Specification ==
[[File:Rockchip_RK3399.png|right]]
* Based on Rockchip RK3399

=== CPU Architecture ===
* big.LITTLE architecture: Dual Cortex-A72 + Quad Cortex-A53, 64-bit CPU
** Full implementation of the ARM architecture v8-A instruction set (both AArch64 and AArch32)
** ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
** ARMv8 Cryptography Extensions
** VFPv4 floating point unit supporting single and double-precision operations
** Hardware virtualization support
** TrustZone technology support
** Full CoreSight debug solution
** One isolated voltage domain to support DVFS
* Cortex-A72 (big cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a72 Dual-core Cortex-A72 up to 2.0GHz CPU]
** Superscalar, variable-length, out-of-order pipeline
** L1 cache 48KB Icache and 32KB Dcache for each A72
** L2 cache 1024KB for big cluster
* Cortex-A53 (little cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a53 Quad-core Cortex-A53 up to 1.5GHz CPU]
** In-order pipeline with symmetric dual-issue of most instructions
** L1 cache 32KB Icache and 32KB Dcache for each A53
** L2 cache 512KB for little cluster
* Cortex-M0 (control processors):
** [https://developer.arm.com/ip-products/processors/cortex-m/cortex-m0 Cortex-M0 CPU]
** Two Cortex-M0 cooperate with the central processors
** Architecture: Armv6-M
** Thumb/Thumb2 instruction set
** 32 bit only

=== GPU Architecture ===
* [https://developer.arm.com/products/graphics-and-multimedia/mali-gpus/mali-t860-and-mali-t880-gpus ARM Mali-T860MP4 Quad-core GPU]
* The highest performance GPUs built on Arm Mali’s famous Midgard architecture, the Mali-T860 GPU is designed for complex graphics use cases and provide stunning visuals for UHD content.
* Frequency 650MHz
* Throughput 1300Mtri/s, 10.4Gpix/s
* Graphic interface standards:
** OpenGL® ES 1.1, 1.2, 2.0, 3.0, 3.1, 3.2. (Panfrost has initial support of 3.0 beginning 2020/02/27)
** Vulkan 1.0, using the Mali binary blob. (Panfrost does not support Vulkan as of 2020/06/24)
** OpenCL™ 1.1, 1.2
** DirectX® 11 FL11_1
** RenderScript™

=== System Memory ===
* RAM Memory:
** LPDDR4
** 800MHz, (limited by RK3399)
** Dual memory channels on the CPU, each 32 bits wide
** Quad memory channels on the RAM chip, each 16 bits wide, 2 bonded together for each CPU channel
** 4GB as a single 366 pin mobile RAM chip
* Storage Memory:
** 64GB eMMC module, can be upgraded to an 128GB eMMC module. (The initial PINE64 community build version shipped with a 128GB eMMC.)
** eMMC version 5.1, HS400, 8 bit on RK3399 side
** Bootable
* SPI flash:
** [[Pinebook Pro SPI]]
** 128Mbit / 16MByte
** 1 bit interface
** Bootable, (first boot device, ahead of eMMC & SD card)
** U-Boot images can be made to work, but as of 2020/06/24 there is no standardized image available.

=== Video out ===
* USB-C Alt mode DP
* Up to 3840x2160 p60, dependant on adapter, (2 lanes verses 4 lanes)

=== Expansion Ports ===
* MicroSD card:
** Bootable
** Supports SD, SDHC and SDXC cards, up to 512GB tested. SDXC standard says 2TB is the maximum.
** Version SD3.0, (MMC 4.5), up to 50MB/s
** SD card Application Performance Class 1 (A1), (or better), recommended by some users, for better IOPS
* USB ports:
** 1 x USB 2.0 Type-A Host Port, bootable
** 1 x USB 3.0 Type-A Host Port, 5Gbps, is not bootable
** 1 x USB 3.0 Type-C OTG Port, 5Gbps, (includes laptop charging function), is not bootable
** Note that high power USB devices may not work reliably on a PBP. Or they may draw enough power to drain the battery even when the PBP is plugged into A.C. One alternative is externally powered USB devices.
* Headphone jack switchable to UART console mux circuit

== Additional hardware ==
Hardware that is not part of the SoC.

=== Battery ===
* Lithium Polymer Battery (10,000 mAH)

=== Display ===
* 14.0" 1920x1080 IPS LCD panel
=== Lid closed magnet ===
There is a magnet to detect when the laptop lid is closed, so action can be taken like sleep. This meets up with the Hall sensor on the daughter / small board to detect lid closed.
* The magnet is located on the LCD panel right side, around 1.5 inches up measure from bottom edge.

=== Webcam ===
* Internal USB attached Webcam

=== Audio ===
* 3.5mm stereo earphone/microphone plug
* Built-in microphone
* Built-in stereo speakers:
** Oval in design
** 3 mm high x 20 mm x 30 mm

=== Network ===
* WiFi:
** 802.11 b/g/n/ac
** Dual band: 2.4Ghz & 5Ghz
** Single antenna
* Bluetooth 5.0

=== Optional NVMe adapter ===
* PCIe 1.1, 2.5 GT/s per lane
** Note that due to errata, PCIe is limited to Gen1. See [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/arch/arm64/boot/dts/rockchip/rk3399.dtsi?id=712fa1777207c2f2703a6eb618a9699099cbe37b this commit].
* Four PCIe lanes, which can not be bifurcated, but can be used with one- or two-lane NVMe cards
* '''M''' keyed, though '''M'''+'''B''' keyed devices will work too
* Maximum length for M.2 card is 80mm (M.2 2280). The following sizes will also work: 2230, 2242, 2260
* Power: 2.5 W continuous, 8.25 W peak momentary
* Does not support SATA M.2 cards
* Does not support USB M.2 cards

== Pinebook Pro Schematics and Certifications ==
* Pinebook Pro Main Board Schematic And Silkscreen:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_mainboard_schematic.pdf Pinebook Pro Main Board ver 2.1 Schematic]
** [https://wiki.pine64.org/images/3/30/Pinebookpro-v2.1-top-ref.pdf Pinebook Pro ver 2.1 Top Layer Silkscreen]
** [https://wiki.pine64.org/images/b/b7/Pinebookpro-v2.1-bottom-ref.pdf Pinebook Pro ver 2.1 Bottom Layer Silkscreen]
* Pinebook Pro Daughter Board Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_daughterboard_schematic.pdf Pinebook Pro Daughter Board ver 2.1 Schematic]
* Optional Pinebook Pro NVMe Adapter Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_NVMe-adapter_schematic.pdf Pinebook Pro NVMe Adapter Board ver 2.1 Schematic]
* Serial Console Earphone Jack Pinout:
** [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pinebook Serial Console Earphone Jack Pinout]
* Pinebook Pro Case:
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.pdf AutoCAD PDF File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.ai AutoCAD AI File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.dwg AutoCAD DWG File ]
* Pinebook Pro Certifications:
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20FCC%20Certificate-S19071103501001.pdf Pinebook Pro FCC Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20CE%20RED%20Certificate-S19051404304.pdf Pinebook Pro CE Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20ROHS%20Compliance%20Certificate.pdf Pinebook Pro RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3399 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2016/0419/758.html Rockchip RK3399 SoC Brief]
** [https://opensource.rock-chips.com/images/d/d7/Rockchip_RK3399_Datasheet_V2.1-20200323.pdf Rockchip RK3399 Datasheet v2.1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.4%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.4, part 1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.3, part 1] and [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part2.pdf part 2]
** [https://files.pine64.org/doc/datasheet/rockpro64/RK808%20datasheet%20V0.8.pdf Rockchip RK808 Datasheet v0.8]
* LPDDR4 SDRAM (366-pin BGA):
** [https://files.pine64.org/doc/datasheet/PinebookPro/micron%20SM512M64Z01MD4BNK-053FT%20LPDDR4%20(366Ball).pdf Micron 366 balls 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/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 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://wiki.pine64.org/images/b/b9/Ds-00220-gd25q127c-rev1-df2f4.pdf GigaDevice 128Mb SPI Flash Datasheet (updated)]
* Wireless and Bluetooth information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/AP6256%20datasheet_V1.7_12282018.pdf AMPAK AP6256 11AC Wi-Fi + Bluetooth5 Datasheet]
* Audio codec:
** [http://www.everest-semi.com/pdf/ES8316%20PB.pdf Everest ES8316 Audio Codec Datasheet]
* LCD panel:
** [https://files.pine64.org/doc/datasheet/PinebookPro/NV140FHM-N49_Rev.P0_20160804_201710235838.pdf 14" 1920x1080 IPS LCD Panel datasheet]
* USB-related information:
** Internal USB 2.0 hub: [https://wiki.pine64.org/images/3/39/GL850G_USB_Hub_1.07.pdf GL850G USB Hub Datasheet]
** USB Type-C Controller: [https://www.onsemi.com/pub/Collateral/FUSB302-D.PDF ON Semiconductor FUSB302 Datasheet]
* Touchpad information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/YX%20HK-9562%20HID%20I2C%20Specification.pdf PineBook Pro Touchpad Specification]
* Keyboard information:
** [https://wiki.pine64.org/images/b/b0/SH68F83V2.0.pdf Sinowealth SH68F83 Datasheet]
** US ANSI: XK-HS002 MB27716023
* Full HD camera sensor:
** [https://files.pine64.org/doc/datasheet/PinebookPro/HK-2145-263.pdf Full HD Camera module specification (in Chinese)]
** [https://files.pine64.org/doc/datasheet/PinebookPro/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GalaxyCore GC2145 Full HD Camera Sensor Datasheet]
* Battery-related information:
** Battery charging IC: [https://www.ti.com/lit/ds/symlink/bq24171.pdf?ts=1607068456825&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FBQ24171 Texas Instruments BQ24171 Datasheet]
** Battery monitoring IC: [https://cdn.datasheetspdf.com/pdf-down/C/W/2/CW2015-Cellwise.pdf Cellwise CW2015 Datasheet]
** [https://files.pine64.org/doc/datasheet/pinebook/40110175P%203.8V%2010000mAh规格书-14.pdf 10000mAH Lithium Battery Specification]
* Power path device:
** [https://wiki.pine64.org/images/9/99/Sis412dn.pdf N-MOS / MOSFET]
* NVMe adapter:
** [https://wiki.pine64.org/images/d/d0/Hirose-FH26W-35S-0.3SHW%2860%29-datasheet.pdf FH26-35S-0.3SHW flat flex connector (compatible, not OEM)]

== Versions ==
Pinebook Pro v1 and v2 were prototype models that did not make it to the public. The "first batch" (First 100 forum preorders) onward are v2.1. [https://forum.pine64.org/showthread.php?tid=8111]

=Skinning and Case Customization=
* Template files for creating custom skins. Each includes template layers for art placement, and CUT lines.
**[https://drive.google.com/open?id=1UKFlC53DO0GJm3Hz1E_669n_HhI45e4n Case Lid Template]
**[https://drive.google.com/open?id=1Q6bKGarMDhvWz3HdGvhL5qDhyHb546ve Case Bottom Template]
**[https://drive.google.com/open?id=1ugI74ygNJ3EN5jXks5jKvdpEAoxIzHo4 Case Palmrest Template]

= Other Resources =
* [https://forum.pine64.org/forumdisplay.php?fid=111 Pinebook Pro Forum]
* [https://forum.pine64.org/forumdisplay.php?fid=98 ROCKPro64 Forum]
* [https://riot.im/app/#/room/#pinebook:matrix.org Matrix Channel] (no login required to read)
* IRC Server: irc.pine64.org Channel: PineBook
* [https://discordapp.com/channels/463237927984693259/622348681538043924 Discord Channel]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [[Pinebook Pro/Freepascal and Lazarus IDE on Manjaro|Freepascal and Lazarus IDE on Pinebook Pro]]

[[Category:PineBook Pro]]
[[Category:Rockchip RK3399]]

Quartz64 Development

2022-09-20T11:41:05Z

CameronNemo: /* Needs Testing */ drivers available for EBC and MIPI DSI

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:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=671676&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: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]]

Quartz64 Development

2022-09-20T11:39:24Z

CameronNemo: /* Linux Kernel Config Options */ Add dsi-dphy, csi-dphy, and rk817-charger driver configs

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:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=671676&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: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 — needs EBC driver
* Microphone Input
* CSI — needs CIF driver
* eDP — needs PHY driver and controller driver
* DSI — needs 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

=== 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]]

Quartz64 Development

2022-09-20T11:31:54Z

CameronNemo: /* Upstreaming Status */ Add dsi-dphy patch series, update rk817-charger series to v10, update csi-dphy 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:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=671676&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: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 — needs EBC driver
* Microphone Input
* CSI — needs CIF driver
* eDP — needs PHY driver and controller driver
* DSI — needs 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

=== 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_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_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]]

Pinebook Pro Software Releases

2022-06-11T06:54:38Z

CameronNemo: /* Void Linux */

= 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/c/arm/ 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]]
As of Nov. 3rd, 2021, Pinebook Pro has No official support (CSC) from Armbian.

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 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]]

=== Official Installation ===
See [[Installing Arch Linux ARM On The Pinebook Pro]] for instructions on how to install the official Arch Linux ARM.

=== Customized Premade Image ===
Arch Linux ARM root filesystem customized for the Pinebook Pro using Manjaro kernel. 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/bpo/edge/pine64-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/stable/ 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-Bullseye.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]

Credits to [https://bugzilla.opensuse.org/show_bug.cgi?id=1194491]
Step 1. Flash Tow-Boot[https://github.com/Tow-Boot/Tow-Boot] to SPI
Step 2. Flash openSUSE image to sd card & insert it
Step 3. When it loads grub, press e and add the following line:

devicetree /boot/dtb/rockchip/rk3399-pinebook-pro.dtb

Press ctrl + x to boot

Work : display, wifi
Not tested : bluetooth
Doesn't work : audio

You may build rpms and see if it fix issues from this repository: [https://github.com/bengtfredh/pinebook-pro-copr]

== FydeOS ==
An operating system based on the Chromium Project

https://fydeos.io/download/device/pinebook-pro

== Void Linux ==

[https://voidlinux.org/ Void Linux] packages U-Boot and a kernel for the Pinebook Pro, but does not distribute any images for the device.

Cameron Nemo ([[User:CameronNemo]]) distributes unofficial Void Linux images for the Pinebook Pro:

* [https://repo.nohom.org/void/images/void-pinebookpro-20220530.img.xz glibc download]
* [https://repo.nohom.org/void/images/void-pinebookpro-musl-20220610.img.xz musl download]

Some notes about the images:

* They were released on 2022-05-30 (glibc) and 2022-06-10 (musl)
* They ship U-Boot 2022.04 and Linux 5.15 (with minimal patches)
* Meant to be uncompressed then flashed to either an SD card or the internal eMMC module
* The root partition is ~1.7GB, and must be expanded manually
* There are very few services enabled on the images by default: udev and some getty's
* The default root password is "voidlinux"

= 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
* Display doesn't always work properly on first boot of installer, usually fixed after a couple tries
* 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 a functional bootloader, leaving the installed system in an unbootable state until it's manually added (if installed to eMMC, the system cannot be booted even to an SD card unless the eMMC is physically switched off or there is U-Boot in the SPI)

[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 consistently 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. Unfortunately, this script is not currently functional, and requires extensive troubleshooting to make work. New instructions are currently being created and will be available here.

'''Word to the wise'''

Currently, following the instructions on the Pinebook pro gentoo github page will *not* result in a functional system. Therefore it is neccesary to follow the instructions given here. Please bear in mind that the Pinebook pro's six arm cores and 4gb of ram are extremely anemic. For example, emerging the package net-libs/webkit-gtk in order to build the minimalist web-browser "surf", a process which takes eighty minutes on an intel core i5-8250U with 8gb of ram, required eight hours of compile time,
Basic installation alone can take 24 hours of compillation, dozens of reboots, and hours of troubleshooting. After that, even installing firefox would take 17 hours.
Now that that's out of the way, we may begin the installation.

'''Preparing the bootloader'''

Installing a functional bootloader can be difficult. Luckily, the tow-boot project provides a UEFI-like experience for some arm-based devices. Furthermore, it is not neccesary install this bootloader manually, as it will continue to be useable even after the disk has been reformatted, as long as the bootloader remains unscathed.

https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-minimal/

No-matter where you intend to install gentoo, the bootloader should always be installed on the eMMC flash, although technically the SD card slot could also be used. Either way, install any of the official Manjaro arm disk images to the internal eMMC (there's no reason not to use the minimal image, as you will not be using this OS for anything). You may use a second operating system installed on an SD-card, or the official Pine64 eMMC USB adapter. Boot into this operating system to ensure that the bootloader functions, but after that you have no further need of it.

Next, if you already have an OS on an SD card, you can use that for installing gentoo. If you don't, you may be pleasantly suprised to find that tow-boot is cabable of booting from a USB drive. Therefore, you may install the same Manjaro image to your USB drive or SD card, and select it from the boot menu. You should now have an unused but bootable OS on the eMMC, and another bootable, usable OS on your external storage.

'''Preparing the Disks'''

Log into your host device as root with the following command:

<code> sudo su </code>

Enter your password.

Let the device on which you intend to install gentoo be refered to hereafter as /dev/<gentoo>. Use the following command to prepare this disk for installation:

<code> fdisk -B /dev/<gentoo> </code>

Note: don't just copy these commands! You should substitute <gentoo> for mmcblk2 for the internal eMMC flash storage.

Note that the first block of the boot partition is block 62500. Delete all partitions, but *do not* re-format the disk. Create a new boot partition starting at 62500, and as it's size select "+1GB". Create a new swap partition. fdisk will try to start it at the beginning of the volume (before the boot partition) Instead, when it prompts you for the starting position, enter in the end sector of the boot partition. It should then tell you that this is within an existing partition, and recommend a slightly higher value. Press enter, and give for the size of the partition any value greater than "+4gb". You need this much ram to be able to suspend your system, and emerge large packages. Don't be stingey - you still have SD cards. I reccomend "+8gb".
Finally, add a root partition starting at the end sector of the swap partition, and use the rest of the disk for it. That should be 50-60 GB depending on the size of your swap and boot partitions.

Lastly, press "t" to set the type of each partition. You may set partition 1 to type 6, 2 to type 82, and 3 to type 83.

to set the partition types of the three partitions.

<code>lsblk</code>

to remind yourself which disk is /dev/<gentoo>
Write the filesystems to these three partitions with the commands:

<code>mkfs.vfat /dev/<gentoo>p1

mkswap /dev/<gentoo>p2

mkfs.ext4 /dev/<gentoo>p3</code>

This may be a slightly different format if you're installing to a usb stick.

'''Installation'''

make the directory for mounting the filesystem you just created. These should be made on the external OS.

<code>mkdir /mnt/gentoo

mount /dev/<gentoo>p3 /mnt/gentoo</code>

cd into this directory and fire up links. Navigate to gentoo.org/downloads and select the stage 3 minimal stage 3 tarball. Download it to your current directory, or move it to that directory from wherever it has been downloaded to. Once you are in the correct directory, unpack the tarball.

<code>tar xpvf stage3-arm64-<blah blah blah></code>

Mount the boot partition.

<code>mount /dev/<gentoo>p1 /mnt/gentoo/boot</code>

Chroot into the mounted directory and Install the operating system as per the AMD64 manual [https://wiki.gentoo.org/wiki/Handbook:AMD64]. Before you emerge anything, however, be sure to set your use flags as follows:

<code>nano /etc/portage/make.conf</code>

<code>MAKEOPTS="-j4 -l4"

ACCEPT_KEYWORDS="* **"

ACCEPT_LICENSE="*"

USE="X gtk bluetooth pulseaudio"
</code>

You can use your own options instead of these if you know what you're doing. It's not super difficult.

Continue installing the operating system, but stop just before emerging the @world set. I don't know if this is necessary, but I haven't had the time to try without doing this. Clone Janikk2099's github repo. It doesn't matter where, and run the script. If it fails run it a couple more times.

<code>git clone https://github.com/Jannik2099/gentoo-pinebookpro

./gentoo-pinebookpro/prepare.sh</code>

Don't follow any of Janikk's other instructions. They appear to be out of date (no offense bro). Let me be clear: DO NOT INSTALL U-BOOT. I don't know what will happen, but it won't be an improvement over the existing boot-loader so don't worry about it.

Finish installing your system until you come to the kernel.

'''Custom Kernel'''

Use sys-kernel/gentoo-kernel-bin as your kernel. You will need to manually edit the kernel configuration. First, select it as your kernel.

<code>eselect kernel list</code>

This should list only one option. Otherwise, select the number matching <code>linux-5.<whatever is latest>-gentoo-dist</code>, and cd into the kernel source directory.

<code>eselect kernel set <number>

cd /usr/src/linux</code>

Begin the kernel configuration

<code>make menuconfig</code>

At this point, you're almost on your own. I don't know a strict cause-and-effect relationship between my kernel config and the behavior of my system. For starters, just go into platform selection and deselect everything except rockchip platforms. Once you're done save your configuration and exit. Make sure boot is mounted, and your fstab is set up with your swap mounted. Make sure dracut is installed.

<code>make

make modules

make dtbs

make install

make modules install

make dtbs_install

ls /lib/modules

dracut -f --kver <name of directory in /lib/modules matching your kernel, *not* the kernel name from eselect>
</code>

emerge the package extlinux and run <code>u-boot-update</code>. Open the extlinux configuration file.

<code>nano /boot/extlinux/extlinux.conf</code>

And configure it as follows:

LABEL <label of your choice, for example GENTOO ARM>

KERNEL /<name of your vmlinuz kernel image. Include the slash, but be relative to boot, not root.>

FDT /dtbs/<kernel-version>/rockchip/rk3399-pinebook-pro.dtb

APPEND initrd=/<name of initramfs image> root=PARTUUID-<nboot partition's PARTUUID, no quotes> rw rootwait
</code>

You can use the blkid command to find the PARTUUID of every partition on the machine. None of this configuration is guaranteed to work, but it worked for me, and given enough fiddling you can get it to work as well.

Now you should reboot the machine and see if it boots into gentoo. If it does: congratulations! If not, too bad. Try again.

== 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.

== Slackware ==

<div style=float:right>[[File:slackware.jpg|right|100px]]</div>

[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.

More information can be found about Slackware in this [https://www.youtube.com/watch?v=A5PFYUttsWA&list=PL1XOSJnvang3IbwySOf6m3PK1gm13hS5s 20 minute video].

[https://docs.slackware.com/slackwarearm:inst Installation instructions].

[https://www.youtube.com/watch?v=QKs_RnFqLO8&list=PL1XOSJnvang3VLmqke2QbRitKtOD6Rm3t Installation guide video]

[[Category:PineBook Pro]]

Pinebook Pro Software Releases

2022-05-30T21:10:31Z

CameronNemo: /* Void Linux */

= 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/c/arm/ 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]]
As of Nov. 3rd, 2021, Pinebook Pro has No official support (CSC) from Armbian.

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 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]]

=== Official Installation ===
See [[Installing Arch Linux ARM On The Pinebook Pro]] for instructions on how to install the official Arch Linux ARM.

=== Customized Premade Image ===
Arch Linux ARM root filesystem customized for the Pinebook Pro using Manjaro kernel. 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/bpo/edge/pine64-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/stable/ 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-Bullseye.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]

Credits to [https://bugzilla.opensuse.org/show_bug.cgi?id=1194491]
Step 1. Flash Tow-Boot[https://github.com/Tow-Boot/Tow-Boot] to SPI
Step 2. Flash openSUSE image to sd card & insert it
Step 3. When it loads grub, press e and add the following line:

devicetree /boot/dtb/rockchip/rk3399-pinebook-pro.dtb

Press ctrl + x to boot

Work : display, wifi
Not tested : bluetooth
Doesn't work : audio

You may build rpms and see if it fix issues from this repository: [https://github.com/bengtfredh/pinebook-pro-copr]

== FydeOS ==
An operating system based on the Chromium Project

https://fydeos.io/download/device/pinebook-pro

== Void Linux ==

[https://voidlinux.org/ Void Linux] packages U-Boot and a kernel for the Pinebook Pro, but does not distribute any images for the device.

Cameron Nemo ([[User:CameronNemo]]) distributes unofficial Void Linux images for the Pinebook Pro:

* [https://repo.nohom.org/void/images/void-pinebookpro-20220530.img.xz glibc download]
* <s>[https://repo.nohom.org/void/images/void-pinebookpro-musl-20220530.img.xz musl download]</s> (suspected to be broken)

Some notes about the images:

* They were released on 2022-05-30
* They ship U-Boot 2022.04 and Linux 5.15.44 (with minimal patches)
* Meant to be uncompressed then flashed to either an SD card or the internal eMMC module
* The root partition is ~1.7GB, and must be expanded manually
* There are very few services enabled on the images by default: udev and some getty's
* The default root password is "voidlinux"

= 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
* Display doesn't always work properly on first boot of installer, usually fixed after a couple tries
* 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 a functional bootloader, leaving the installed system in an unbootable state until it's manually added (if installed to eMMC, the system cannot be booted even to an SD card unless the eMMC is physically switched off or there is U-Boot in the SPI)

[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 consistently 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. Unfortunately, this script is not currently functional, and requires extensive troubleshooting to make work. New instructions are currently being created and will be available here.

'''Word to the wise'''

Currently, following the instructions on the Pinebook pro gentoo github page will *not* result in a functional system. Therefore it is neccesary to follow the instructions given here. Please bear in mind that the Pinebook pro's six arm cores and 4gb of ram are extremely anemic. For example, emerging the package net-libs/webkit-gtk in order to build the minimalist web-browser "surf", a process which takes eighty minutes on an intel core i5-8250U with 8gb of ram, required eight hours of compile time,
Basic installation alone can take 24 hours of compillation, dozens of reboots, and hours of troubleshooting. After that, even installing firefox would take 17 hours.
Now that that's out of the way, we may begin the installation.

'''Preparing the bootloader'''

Installing a functional bootloader can be difficult. Luckily, the tow-boot project provides a UEFI-like experience for some arm-based devices. Furthermore, it is not neccesary install this bootloader manually, as it will continue to be useable even after the disk has been reformatted, as long as the bootloader remains unscathed.

https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-minimal/

No-matter where you intend to install gentoo, the bootloader should always be installed on the eMMC flash, although technically the SD card slot could also be used. Either way, install any of the official Manjaro arm disk images to the internal eMMC (there's no reason not to use the minimal image, as you will not be using this OS for anything). You may use a second operating system installed on an SD-card, or the official Pine64 eMMC USB adapter. Boot into this operating system to ensure that the bootloader functions, but after that you have no further need of it.

Next, if you already have an OS on an SD card, you can use that for installing gentoo. If you don't, you may be pleasantly suprised to find that tow-boot is cabable of booting from a USB drive. Therefore, you may install the same Manjaro image to your USB drive or SD card, and select it from the boot menu. You should now have an unused but bootable OS on the eMMC, and another bootable, usable OS on your external storage.

'''Preparing the Disks'''

Log into your host device as root with the following command:

<code> sudo su </code>

Enter your password.

Let the device on which you intend to install gentoo be refered to hereafter as /dev/<gentoo>. Use the following command to prepare this disk for installation:

<code> fdisk -B /dev/<gentoo> </code>

Note: don't just copy these commands! You should substitute <gentoo> for mmcblk2 for the internal eMMC flash storage.

Note that the first block of the boot partition is block 62500. Delete all partitions, but *do not* re-format the disk. Create a new boot partition starting at 62500, and as it's size select "+1GB". Create a new swap partition. fdisk will try to start it at the beginning of the volume (before the boot partition) Instead, when it prompts you for the starting position, enter in the end sector of the boot partition. It should then tell you that this is within an existing partition, and recommend a slightly higher value. Press enter, and give for the size of the partition any value greater than "+4gb". You need this much ram to be able to suspend your system, and emerge large packages. Don't be stingey - you still have SD cards. I reccomend "+8gb".
Finally, add a root partition starting at the end sector of the swap partition, and use the rest of the disk for it. That should be 50-60 GB depending on the size of your swap and boot partitions.

Lastly, press "t" to set the type of each partition. You may set partition 1 to type 6, 2 to type 82, and 3 to type 83.

to set the partition types of the three partitions.

<code>lsblk</code>

to remind yourself which disk is /dev/<gentoo>
Write the filesystems to these three partitions with the commands:

<code>mkfs.vfat /dev/<gentoo>p1

mkswap /dev/<gentoo>p2

mkfs.ext4 /dev/<gentoo>p3</code>

This may be a slightly different format if you're installing to a usb stick.

'''Installation'''

make the directory for mounting the filesystem you just created. These should be made on the external OS.

<code>mkdir /mnt/gentoo

mount /dev/<gentoo>p3 /mnt/gentoo</code>

cd into this directory and fire up links. Navigate to gentoo.org/downloads and select the stage 3 minimal stage 3 tarball. Download it to your current directory, or move it to that directory from wherever it has been downloaded to. Once you are in the correct directory, unpack the tarball.

<code>tar xpvf stage3-arm64-<blah blah blah></code>

Mount the boot partition.

<code>mount /dev/<gentoo>p1 /mnt/gentoo/boot</code>

Chroot into the mounted directory and Install the operating system as per the AMD64 manual [https://wiki.gentoo.org/wiki/Handbook:AMD64]. Before you emerge anything, however, be sure to set your use flags as follows:

<code>nano /etc/portage/make.conf</code>

<code>MAKEOPTS="-j4 -l4"

ACCEPT_KEYWORDS="* **"

ACCEPT_LICENSE="*"

USE="X gtk bluetooth pulseaudio"
</code>

You can use your own options instead of these if you know what you're doing. It's not super difficult.

Continue installing the operating system, but stop just before emerging the @world set. I don't know if this is necessary, but I haven't had the time to try without doing this. Clone Janikk2099's github repo. It doesn't matter where, and run the script. If it fails run it a couple more times.

<code>git clone https://github.com/Jannik2099/gentoo-pinebookpro

./gentoo-pinebookpro/prepare.sh</code>

Don't follow any of Janikk's other instructions. They appear to be out of date (no offense bro). Let me be clear: DO NOT INSTALL U-BOOT. I don't know what will happen, but it won't be an improvement over the existing boot-loader so don't worry about it.

Finish installing your system until you come to the kernel.

'''Custom Kernel'''

Use sys-kernel/gentoo-kernel-bin as your kernel. You will need to manually edit the kernel configuration. First, select it as your kernel.

<code>eselect kernel list</code>

This should list only one option. Otherwise, select the number matching <code>linux-5.<whatever is latest>-gentoo-dist</code>, and cd into the kernel source directory.

<code>eselect kernel set <number>

cd /usr/src/linux</code>

Begin the kernel configuration

<code>make menuconfig</code>

At this point, you're almost on your own. I don't know a strict cause-and-effect relationship between my kernel config and the behavior of my system. For starters, just go into platform selection and deselect everything except rockchip platforms. Once you're done save your configuration and exit. Make sure boot is mounted, and your fstab is set up with your swap mounted. Make sure dracut is installed.

<code>make

make modules

make dtbs

make install

make modules install

make dtbs_install

ls /lib/modules

dracut -f --kver <name of directory in /lib/modules matching your kernel, *not* the kernel name from eselect>
</code>

emerge the package extlinux and run <code>u-boot-update</code>. Open the extlinux configuration file.

<code>nano /boot/extlinux/extlinux.conf</code>

And configure it as follows:

LABEL <label of your choice, for example GENTOO ARM>

KERNEL /<name of your vmlinuz kernel image. Include the slash, but be relative to boot, not root.>

FDT /dtbs/<kernel-version>/rockchip/rk3399-pinebook-pro.dtb

APPEND initrd=/<name of initramfs image> root=PARTUUID-<nboot partition's PARTUUID, no quotes> rw rootwait
</code>

You can use the blkid command to find the PARTUUID of every partition on the machine. None of this configuration is guaranteed to work, but it worked for me, and given enough fiddling you can get it to work as well.

Now you should reboot the machine and see if it boots into gentoo. If it does: congratulations! If not, too bad. Try again.

== 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.

== Slackware ==

<div style=float:right>[[File:slackware.jpg|right|100px]]</div>

[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.

More information can be found about Slackware in this [https://www.youtube.com/watch?v=A5PFYUttsWA&list=PL1XOSJnvang3IbwySOf6m3PK1gm13hS5s 20 minute video].

[https://docs.slackware.com/slackwarearm:inst Installation instructions].

[https://www.youtube.com/watch?v=QKs_RnFqLO8&list=PL1XOSJnvang3VLmqke2QbRitKtOD6Rm3t Installation guide video]

[[Category:PineBook Pro]]

User:CameronNemo

2022-05-30T20:55:47Z

CameronNemo: Created page with "Hey. I package software for Void Linux. Do other stuff too. * GitHub: CameronNemo * Matrix: @cnemo:matrix.org"

Hey. I package software for Void Linux. Do other stuff too.

* GitHub: CameronNemo
* Matrix: @cnemo:matrix.org

Pinebook Pro

2022-05-30T20:54:18Z

CameronNemo: /* Pinebook Pro images */

= User Guide =
== Introducing PineBook Pro ==
[[File:PBP.jpg|400px|thumb|right|Pinebook Pro running Debian with MATE]]

The Pinebook Pro is a Linux and *BSD ARM laptop from [https://www.pine64.org/ PINE64]

It is built to be a compelling alternative to mid-ranged Chromebooks that people convert into Linux laptops. It features an IPS 1080p 14″ LCD panel, a premium magnesium alloy shell, high capacity eMMC storage, a 10,000 mAh capacity battery, and the modularity that only an open source project can deliver.

It's compact and slim dimensions are 329mm x 220mm x 12mm (WxDxH).

Key features include: the RK3399 SOC; USB-C for data, video-out and power-in (3A 5V); privacy switches for the microphone, BT/WiFi module, and camera; and expandable storage via NVMe (PCIe x4) with an optional adapter.

The Pinebook Pro is equipped with 4GB LPDDR4 system memory, high capacity eMMC flash storage, and 128Mb SPI boot Flash. The I/O includes: 1 x micro SD card reader (bootable), 1 x USB 2.0, 1 x USB 3.0, 1 x USB type C Host with DP 1.2 and power-in, PCIe x4 for an NVMe SSD drive (requires an optional adapter), and UART (via the headphone jack by setting an internal switch).

The keyboard and touchpad both use the USB 2.0 protocol. The LCD panel uses eDP MiPi display protocol.

Many different Operating Systems (OS) are freely available from the open source community and partner projects. These include various flavors of Linux (Ubuntu, Debian, Manjaro, etc.) and *BSD.

== Software and OS Image Downloads ==

=== Default Manjaro KDE Desktop Quick Start ===

When you first get your Pinebook Pro and boot it up for the first time, it'll come with Manjaro using the KDE desktop. The Pinebook Pro is officially supported by the Manjaro ARM project, and support can be found on the [https://forum.manjaro.org/c/manjaro-arm/78 Manjaro ARM forums.]

On first boot, it will ask for certain information such as your timezone location, keyboard layout, username, password, and hostname. Most of these should be self-explanatory. Note that the hostname it asks for should be thought of as the "codename" of your machine, and if you don't know what it's about, you can make something up (use a single word, all lower case, no punctuation; e.g. "pbpro").

After you're on the desktop, be sure to update it as soon as possible and reboot after updates are finished installing. If nothing appears when you click on the Networking icon in your system tray to connect to your Wi-Fi, ensure the Wi-Fi [https://wiki.pine64.org/index.php/Pinebook_Pro#ANSI_Fn_.2B_F_keys_wrong_for_F9.2C_F10.2C_F11_and_F12 privacy switch] is not disabled.

=== Pinebook Pro images ===
Under [[Pinebook Pro Software Release]] you will find a complete list of currently supported Operating System images that work with the Pinebook as well as other related software.

The list includes OS images and descriptions of:

* [[PinebookPro_Software_Release#Manjaro ARM|Manjaro ARM]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Armbian|Armbian]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Twister OS|Twister OS]] (microSD Boot)
* [[PinebookPro_Software_Release#Fedora|Fedora]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Arch_Linux_ARM|Arch Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#postmarketOS|Postmarket OS]] (microSD and USB boot)
* [[PinebookPro_Software_Release#Kali Linux|Kali Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#DietPi|DietPi]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Q4OS|Q4OS]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#NetBSD|NetBSD]] (microSD and eMMC Boot)
* [[Pinebook_Pro_Software_Release#OpenBSD|OpenBSD release for ARM64]]
* [[Pinebook_Pro_Software_Release#Gentoo|Gentoo]]
* [[Pinebook_Pro_Software_Release#Slackware|Slackware (microSD boot)]]
* [[Pinebook_Pro_Software_Release#Void_Linux|Void Linux]]

== Keyboard ==
The Pinebook Pro is available in two keyboard configurations: ISO and ANSI. Both the keyboard and touchpad in the Pinebook Pro use the USB 2.0 protocol and show up as such in xinput. The keyboard features function (Fn) keys in the F-key row, which include display brightness controls, sound volume, touchpad lock, and other functionality. There is also a custom PINE64 logo key that functions as Menu/Super key. It has also a secondary functionality for setting the privacy switches.

The keyboard firmware binary can be flashed from userspace using the provided open source utility.

{{warning|DO NOT update the keyboard firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed, see the [https://reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Documentation for the keyboard can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]].

=== Typing special characters ===
The [[Wikipedia:British_and_American_keyboards#Other_keyboard_layouts|UK ISO Layout]] does not have dedicated keys for characters like the German umlauts (Ä,Ö,Ü, etc). Certain characters can still be generated by means of either key combinations or key sequences.
{| class="wikitable"
!Character
!Key combination/sequence
|-
|Ä, Ö, Ü, ä, ö, ü
|[[Wikipedia:AltGr_key|[AltGr]]]+'[' followed by [A], [O], [U], [a], [o] or [u]
|-
|µ
|[AltGr]+[m]
|-
|Ø, ø
|[AltGr]+[O], [AltGr]+[o]
|-
|@
|[AltGr]+[q] (as on the German layout)
|-
|ß
|[AltGr]+[s]
|-
|§
|[AltGr]+[S]
|-
|°
|[AltGr]+[)]
|}

=== Privacy Switches ===
There are three privacy switches mapped to the F10, F11 and F12 keys on the Pinebook Pro keyboard. They de/activate the following:

{| class="wikitable"
|+ Privacy switch function and description
! Combination
! Effect
! Description
! Notes
|-
! scope=row | PINE64 logo key+F10
| Microphone Privacy switch
| CAPs lock LED blinks. 2 blinks = enabled, 3 blinks = disabled
|-
! scope=row | PINE64 logo key+F11
| WiFi Privacy switch
| NUM lock LED blinks. 2 blinks = WiFi enabled / privacy switch disabled, 3 blinks = WiFi disabled / privacy switch enabled.
| '''Re-enabling requires reboot''' (or a [//forum.pine64.org/showthread.php?tid=8313&pid=52645#pid52645 command line hack to bind/unbind]).
|-
! scope=row | PINE64 logo key+F12
| Camera privacy switch
| CAPs lock and NUM lock LEDs blink together. 2 blinks = enabled, 3 blinks = disabled
| Can use tools like '''<code>lsusb</code>''' to detect camera's presence. If not detected, check privacy switch.
|}

'''(Press the PINE64 logo key plus F10/F11/F12) for 3 seconds)'''

The keyboard operates on firmware independent of the operating system. It detects if one of the F10, F11 or F12 keys is pressed in combination with the Pine key for 3 seconds. Doing so disables power to the appropriate peripheral, thereby disabling it. This has the same effect as cutting off the power to each peripheral with a physical switch. This implementation is very secure, since the firmware that determines whether a peripheral gets power is not part of the Pinebook Pro’s operating system. So the power state value for each peripheral cannot be overridden or accessed from the operating system. The power state setting for each peripheral is stored across reboots inside the keyboard's firmware flash memory.

=== Basic summary of replacing keyboard ===

This guide is very basic and should be fleshed out with (better) pictures. There just isn't a list of steps anywhere else yet.

Here's what the replacement keyboard looks like:

[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (front)]]
[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (back)]]

''Step 0'': If changing from ISO keyboard to ANSI keyboard, or vice versa, be sure to have a system capable of running the firmware updater that you can access either remotely or with a USB keyboard beyond the internal keyboard, as the firmware for each is very different and keys won't work correctly. See https://forum.pine64.org/showthread.php?tid=8407 (and for NetBSD, https://forum.pine64.org/showthread.php?tid=8716).

''Step 1'': The remove back back panel.

There are 10 screws on the back that must be removed, and the back panel detached. I recommend using a PH0 bit. The speakers may remain attached via glue to the case and should be carefully pried off. When this is done, taking photos of how everything looks now can help put it all back together later.

[[File:Pinebook_Pro_keyboard-replacement-screws.jpg|300px|Remove the back panel]]

''Step 2'': Places to unscrew.

There are 3 items screwed into the keyboard frame that must be removed. There are 2 large screws for daughter board, 3 large screws and 1 small screw for mainboard, and 4 small screws for battery. Be sure to not lose them. I recommend a PH00 bit for the large screws on the daughter and main boards and a PH1 bit for the small screws on the battery and mainboard.

[[File:Pinebook_Pro_new_keyboard-back-removed.jpg|300px|Remove the back panel]]

''Step 3'': Remove the battery.

Once the battery screws are removed, it should be unplugged from the mainboard and removed. Note that there are two unconnected cables lying around, that should remain unconnected. They are used when the battery is disconnected entirely.

[[File:Pinebook_Pro_new_keyboard-zoom-mainboard.jpg.jpg|300px|Zoom on the mainboard]]
[[File:Pinebook_Pro_new_keyboard-zoom-daughterboard.jpg|300px|Zoom on the daughterboard]]

''Step 4'': Unplug the ribbon cables.

NOTE: you should remove the M.2 adapter board now if you have one installed. See elsewhere in this wiki for instructions on how to install/remove that piece.

There are several ribbon cables. To remove, flip up the tab and gentle pull the ribbon out.

* One cable runs from the mainboard to the daughterboard underneath the battery. Detach from both ends. With the battery removed, detach from keyboard shell, and set aside for the new keyboard shell.
* One cable runs between the touchpad and the mainboard. Detach from both ends, and also set aside.
* One cable runs between the keyboard and the mainboard. This one remains attached to the keyboard and only needs to be detached from the mainboard.
* One cable from the LCD attaches near the lid hinge. It should be just unplugged.

''Step 5'': Detach microphone, speakers, and antenna.

[[File:Pinebook_Pro_microphone_removed.jpg|300px|thumb|right|One of the Pinebook Pro microphones after removal]]

The speakers, microphone, and antenna don't have to be detached from the mainboard, but they need to be detached from the keyboard shell. The microphones are held in place by tape, and the speakers have sticky sides. The speakers are found obviously, but the microphones (two of) can be found between the battery and the hinge area. Each microphone can be carefully pulled/wedged out of its position by a small screwdriver or pick. The antenna, similar to the microphones, is found near the hinge area and to the top left of the battery.

''Step 6'': Remove mainboard and daughterboard.

At this point, the mainboard and daughterboards should be removed. When unscrewed (see Step 2) they should pull out fairly easily. Put them aside (including microphones and speakers if left attached.)

[[File:Pinebook_Pro_new_keyboard-all-boards-removed.jpg|300px|All boards removed]]

''Step 7'': Detach the LCD panel.

Step 2 didn't tell you, there are 6 more screws to remove here, 3 for each of the hinges. I recommend a PH1 bit for these screws. Unscrew these and the LCD panel will be able to be removed. You may have to jiggle or move the hinges for this. When detached, be sure to place the LCD panel such that the display is protected.

[[File:Pinebook_Pro_new_keyboard-detached-display.jpg|300px|Display detached]]
[[File:Pinebook_Pro_new_keyboard-detached-display2.jpg|300px|Display detached (front)]]

''Step 8'': Try Not To Break Your Touchpad, or, How I Learned To Love Things That Bend

'''NOTE This section really feels like you're going to break something.'''

The touchpad is glued to the keyboard shell and it's glued well. There are two places it is glued to. If you can, only the middle must be force-detached. You will think you're going to break it. Gently apply increasing force until the glue begins to detach (you will hear a crackle as it comes off), and continue very slowly until the whole thing is detached. This may take minutes due to that feeling you're going to break it.

I found it helpful to lift the top left plastic bit on the keyboard to unstick that portion of the touchpad, then push on the top left portion of the touchpad to unstick the rest of the touchpad.

[[File:Pinebook_Pro_new_keyboard-touchpad1.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad2.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad3.jpg|300px|Unmouting the touchpad]]

''Step 9'': Over the hill, touchpad goes into new shell.

In the new keyboard shell put the touchpad back where it was, hopefully the glue will remain sufficiently attached. If there is a glue issue, this guide unfortunately has no advice currently.

[[File:Pinebook_Pro_new_keyboard-install-touchpad.jpg|300px|Install the touchpad]]

''Step 10'': Reattach the LCD panel.

The LCD panel should slot back into the keyboard frame, the same way it came out. If the hinges were moved, they should be *very* *gently* closed such that the LCD panel and keyboard closed like normal for the remaining steps.

''Step 11'': Tape it out.

Move any tape from the old keyboard shell to the new one. These items protect the mainboard and daughterboard, and keep various wires in their right place. Some are grey and some are black. For tape that holds the speakers, microhones, or their cables in place, do not reattach yet.

''Step 12'': Board install.

Install the mainboard, the daughtboard, and their connecting ribbon cable. Be sure to put the boards in place, 2 large flat screws for the daughterboard, 3 large flat screws and one small screw for the mainboard, before attempting to place the ribbon.

''Step 13'': Microphone, speaker, and antenna install.

Reattach the microphones, antenna, and speakers to their respective areas, making sure that both are properly oriented - the speaker "out" faces up, and the microphone cables as connected must face up (these are opposite directions.)

''Step 14'': Reattach other ribbon cables.

NOTE: this would be a good time to attach/install the M.2 adapter board if that is desired. See elsewhere in this wiki for those instructions.

The LCD panel, keyboard and touchpad ribbon cables should be reattached. Make sure the flap is open, insert the ribbon into the slot (a portion of the cable will disappear), and push the flap down. The cable should not be easy to pull out.

''Step 15'': Reattach the battery, and final re-tape.

The battery should be installed with the 4 screws holding it in place, and the connector attached to the mainboard. Be sure to keep the two other cables remain unconnected. Ensure all wires and other tapes are held in place.

''Step 16'': Reattach the back panel.

Put the back panel back on, and reattach the 10 screws.

''Step 17'': If you changed from ISO to ANSI or from ANSI to ISO, you'll need to update your firmware now. See the links in Step 0 above.

== Touchpad (trackpad) ==
Documentation for the touchpad can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]]. It is the only component of the Pinebook Pro held in place with strong adhesive tape. Here are some of its features:

* 2 actuating buttons.

* multi-touch functionality.

* A matte finish that your finger can slide along easily.

* A reasonable size (96mm × 64mm; diagonal: 115.378mm or 4.542”).

=== Troubleshooting ===

If you are having trouble using 2 fingers to scroll or emulate the click of a mouse's right-button, then try these solutions:

* Update the firmware.

* Keep your 2 fingers spread apart rather than close together.

* Individual programs might need to be configured specially.

:* For smooth scrolling and gestures under X-Windows, ''Firefox'' should be launched with with the following environment variable assignment:

::: <code>MOZ_USE_XINPUT2=1</code>

* Experiment with other settings, via [[#X-Windows Configuration|X-Windows Configuration]] or some other system preferences; for example, you could disable double-finger scrolling, and instead enable scrolling by sliding one finger along the edge of the touchpad.

=== Firmware ===
The touchpad controller is connected to the keyboard controller. All touchpad events go through the keyboard controller and it's software, then to the keyboard controller's USB port. Note that the touchpad does have separate firmware, (which has to be written through the keyboard controller). The touchpad vendor’s firmware binary can be flashed from userspace using the following open source command-line utility:

* Kamil Trzciński’s [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater pinebook-pro-keyboard-updater].

Naturally, forks have begun to appear:

* Jack Humbert’s [https://github.com/jackhumbert/pinebook-pro-keyboard-updater fork]

* Dragan Simic’s [https://github.com/dragan-simic/pinebook-pro-keyboard-updater fork]. This one has recently delivered a much improved firmware from the vendor, which greatly improves the control of the cursor (see this [https://forum.pine64.org/showthread.php?tid=14531 thread] for discussion); before installing this update, consider resetting to the defaults any configuration of your touchpad.

'''Every Pinebook Pro produced before September 2021 should have its keyboard and touchpad firmware updated.'''

{{warning| DO NOT update the touchpad firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed. See [//old.reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Before updating ''any'' firmware, your Pinebook Pro should be either fully charged or, preferably, running from mains. This utility will be writing data to chips on the keyboard and touchpad, so a loss of power during any stage of the update can result in irrecoverable damage to your touchpad or keyboard.

The scripts ought to work on all OSs available for the Pinebook Pro. Some OSs may, however, require installation of relevant dependencies. The instructions below assume a Debian desktop. To install these dependencies, newer Pinebook Pro models that come with Manjaro will require a different command.

There are two keyboard versions of the Pinebook Pro: ISO and ANSI. You need to know which model you have prior to running the updater.
Firmware update steps for both models are listed below.

What you will need:

* Connection to WiFi (for getting dependencies).

* Your Pinebook Pro fully charged or running from mains power.

* An external USB keyboard & mouse (or access to the Pinebook Pro via SSH. Please note that for some configurations, the SSH service might not be available without first having logged in once; in this case, you will definitely want at least an external keyboard).

==== ISO Model ====

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 iso
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 iso
sudo poweroff # do not use 'reboot'
</pre>

==== ANSI Model ====

{{Hint| Note: Running step 1 on the ANSI keyboard model will make the keyboard and touchpad inaccessible until step 2 is run, so an external keyboard must be connected to complete the update on this model!}}

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 ansi
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 ansi
sudo poweroff # do not use 'reboot'
</pre>

When done, if some of the keys produce incorrect characters, please check your OS’s language settings. For ANSI users, the default OS may have shipped with English UK as the default language; you can change it to English US if desired.

==== Revised Firmware ====

In addition, you might consider using revised firmware data; this is one final step that should not require a reboot:

Step 3: '''ISO''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_iso.hex
</pre>

Step 3: '''ANSI''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_ansi.hex
</pre>

=== X-Windows Configuration ===
''Before making adjustments, consider updating the firmware; reset your adjustments before updating the firmware, so that your adjustments do not interfere with new functionality.''

Some forum members have found that an adjustment to X-Windows will allow finer motion in the touchpad. If you use the '''Synaptic''' mouse/touchpad driver, use this command to make the change live:
<pre>synclient MinSpeed=0.25</pre>
You may experiment with different settings, but 0.25 was tested as helping noticeably. 
 
To make the change persist across reboots, change the file <code>/etc/X11/xorg.conf</code> similar to below:
<pre> Section "InputClass"
Identifier "touchpad catchall"
Driver "synaptics"
MatchIsTouchpad "on"
MatchDevicePath "/dev/input/event*"
Option "MinSpeed" "0.25"
EndSection</pre>
The line <code>Option "MinSpeed" "0.25"</code> is the change. 
 
Another forum user built on the above settings a little, and have found these to be very good:
<pre>synclient MinSpeed=0.25
synclient TapButton1=1
synclient TapButton2=3
synclient TapButton3=2
synclient FingerLow=30
synclient PalmDetect=1
synclient VertScrollDelta=64
synclient HorizScrollDelta=64</pre>

<code>FingerLow</code> has the same value as 'FingerHigh' in one config (30). It is believed to help reduce mouse movement as you lift your finger, but it's unknown whether synaptic works like this.
You may find this config to be comfortable for daily use.
 

<code>TabButton</code> allows to just tab the touchpad instead of physically pressing it down (to get this click noise).

The <code>right mouse click</code> is emulated by tapping with two fingers on the touchpad. If you feel that this is not very responsive you can try this value:
<pre> synclient MaxTapTime=250 </pre>

Some users may encounter an issue with the mouse jumping when typing when using libinput driver (has not been test with synaptic) due to their hand hitting the touchpad which can be fixed by updating the xorg settings to disable it while typing. One can disable the touchpad while typing by setting the below option in the xorg config simliar to the previou example.

<pre>
Option "DisableWhileTyping" "on"
</pre>

The setting can be verified by using the xinput command to first list the devices and then listing the properties for the Touchpad device. Exact commands to check this have been omitted for save of brevity. If DisableWhileTyping is shown enabled but does not appear to be working the issue may be due to the fact that the keyboard is connected to a USB bus which causes it to be seen as a external keyboard. To resolve this one can add the config below which sets the keyboard to internal to ensure the DisableWhileTyping works properly.

You will need to edit <code>/etc/libinput/local-overrides.quirks</code> and add the following lines:
<pre>
[Serial Keyboards]
MatchUdevType=keyboard
MatchBus=usb
AttrKeyboardIntegration=internal
</pre>

Once X11 is restarted the new setting should now take effect and you will no longer be able to use the touchpad while typing which will mostly eliminate the mouse jumping issue.

== Power Supply ==
* Input Power: 5V DC @ 3A
* Mechanical: 3.5mm OD / 1.35mm ID, Barrel jack
* USB-C 5V, 15W PD quickcharge
* Only use one power input at a time, barrel jack OR USB-C

== LEDs ==
In total, there are four LEDs on the Pinebook Pro, three of which are placed in the top-left side of the keyboard, and one near the barrel port:

# The red LED next to the barrel port indicates charging, in three ways. First, it will illuminate steadily when either the factory power supply or a USB Type-C charger is connected to the Pinebook Pro, and the battery is getting charged. Second, if the battery is at 100%, the LED will remain turned off regardless of the connected power input; however, this is [https://forum.pine64.org/showthread.php?tid=10899 rather rarely achieved]. Third, this LED will flash at 0.5 Hz if there are any problems that prevent charging, such as the battery becoming too hot.
# The power indicator LED, above the keyboard, supports three different colors: green, amber and red. It is also capable of flashing to indicate eMMC activity. In the default Debian with MATE build, green LED means power and red means suspend (amber is unused).
# The green NumLock LED, above the keyboard.
# The green CapsLock LED, above the keyboard.

The NumLock and CapsLock LEDs serve their usual purposes on a keyboard, but they also have a secondary function. When the privacy switches get activated they blink to confirm that the switch has been activated.

== Webcam ==
{{Hint| You can use Cheese to test the Camera functionality}}
* Streaming video resolutions supported, (uncompressed):
** 320 x 240
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Still frame resolutions supported:
** 160 x 120
** 176 x 144
** 320 x 240
** 352 x 288
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200

== Microphones ==
While it has been said that some Pinebook Pro units contain only one microphone despite having two labeled microphone holes on the outer casing, other units do indeed contain two microphones. It is presently unclear which batches have either configuration; units from the initial community batch of 1000 units (following the initial 100) are believed to contain two, populating both labeled holes.

The wires leading to both microphones connect to the mainboard with a small white plastic connector, located directly adjacent to the ribbon cable attachment point for the keyboard interface.

'''Microphones not working?'''

If pavucontrol input doesn't show microphone activity try changing the [[Pinebook_Pro#Privacy_Switches|privacy switches]]. If the switches are in the correct place and microphone input isn't working you can run <code>alsamixer</code> from the command line, hit F6 and select the es8316, hit F4 to get to the capture screen, select the bar labeled ADC, increase the gain to 0dB, change the audio profile in pavucontrol to another one with input. Additionally you may want to modify ADC PGA to get the levels to where you want them. If that still hasn't fixed it you may want to check that the microphone connector is plugged in (see the section [[#Technical Reference|Technical Reference]]).

== Bluetooth and WiFi ==
[[File:PinebookPro_WirelessIC_Location.jpg|400px|thumb|right|The Pinebook Pro's AP6256 wireless module]]
===Hardware Overview===
The Pinebook Pro contains an AMPAK AP6256 wireless module to provide Wi-Fi (compliant to IEEE 802.11ac) and Bluetooth (compliant to Bluetooth SIG revision 5.0). The module contains a Broadcom transceiver IC, believed to be the BCM43456, as well as the support electronics needed to allow the Wi-Fi and Bluetooth modes to share a single antenna.

The wireless module interfaces with the Pinebook Pro’s system-on-chip using a combination of three interfaces: Bluetooth functionality is operated by serial UART and PCM, while the Wi-Fi component uses SDIO. It is unknown if the module’s Bluetooth capabilities are usable under operating systems that do not support SDIO.

The module’s RF antenna pin is exposed on the mainboard via a standard Hirose U.FL connector, where a coaxial feedline links it to a flexible adhesive antenna situated near the upper right corner of the Pinebook Pro’s battery. As the RF connector is fragile and easily damaged, it should be handled carefully during connection and disconnection, and should not be reconnected frequently.

===Issues===
Problems have been reported with the Wi-Fi transceiver’s reliability during extended periods of high throughput, especially on the 2.4 GHz band. While the cause of this has yet to be determined, switching to the 5 GHz band may improve stability.

Since the Bluetooth transceiver shares both its spectrum and antenna with 2.4 GHz Wi-Fi, simultaneous use of these modes may cause interference, especially when listening to audio over Bluetooth. If Bluetooth audio cuts out frequently, switching to the 5 GHz band – or deactivating Wi-Fi – may help.

===Wi-Fi Capabilities===
Wi-Fi on the Pinebook Pro is capable of reaching a maximum data transfer rate of approximately 433 megabits per second, using one spatial stream. The transceiver does not support multiple spatial streams or 160-MHz channel bandwidths.

The Wi-Fi transceiver supports the lower thirteen standard channels on the 2.4 GHz band, using a bandwidth of 20 MHz. At least twenty-four channels are supported on the 5 GHz band, spanning frequencies from 5180 to 5320 MHz, 5500 to 5720 MHz, and 5745 to 5825 MHz, with bandwidths of 20, 40, or 80 MHz.

Maximum reception sensitivity for both bands is approximately -92 dBm. The receiver can tolerate input intensities of no more than -20 dBm on the 2.4 GHz band, and no more than -30 dBm on the 5 GHz band. Maximum transmission power is approximately +15 dBm for either band, falling further to approximately +10 dBm at higher data transfer rates on the 5 GHz band.

With current available drivers and firmware, the Wi-Fi interface supports infrastructure, ad-hoc, and access-point modes with satisfactory reliability. Monitor mode is not presently supported. Wi-Fi Direct features may be available, but it is unclear how to make use of them under Linux.

Be aware that Linux userspace utilities, such as <code>iw</code>, may report inaccurate information about the capabilities of wireless devices. Parameter values derived from vendor datasheets, or direct testing, should be preferred to the outputs of hardware-querying tools.

===Bluetooth Capabilities===
Bluetooth data transfer speeds have an indicated maximum of 3 megabits per second, but it is unclear what practical data rates can be expected. Audio streaming over Bluetooth is functioning normally, as is networking. Bluetooth Low-Energy functions, such as interacting with Bluetooth beacons, have not yet been tested conclusively.

The Bluetooth transceiver supports all 79 channel allocations, spanning frequencies from 2402 MHz to 2480 MHz. Reception sensitivity is approximately -85 dBm, with a maximum tolerable reception intensity of -20 dBm. Bluetooth transmission power is limited to +10 dBm.

===Disabling Bluetooth===

To disable Bluetooth under Linux once:

sudo rfkill block bluetooth

To confirm if Bluetooth under Linux is disabled:

rfkill

To disable Bluetooth on boot (note: for distributions such as Manjaro XFCE see the step below):

sudo systemctl enable rfkill-block@bluetooth

To disable Bluetooth on certain distributions, such as Manjaro XFCE, right click on the Bluetooth panel icon, select plugins, then PowerManager, then configuration and then deselect the auto power on option

== LCD Panel ==
* Model: BOE NV140FHM-N49
* 14.0" (35.56 cm) diagonal size
* 1920x1080 resolution
* 60 Hz refresh rate
* IPS technology
* 1000:1 contrast
* 250 nit brightness
* 63% sRGB coverage
* 6-bit color
* 30-pin eDP connection

Some people have tested hardware video decode using the following;

<pre>ffmpeg -benchmark -c:v h264_rkmpp -i file.mp4 -f null -</pre>

== External ports list ==
Here are a list of the external ports. See [[Pinebook_Pro#Expansion_Ports|Technical Reference - Expansion Ports]] for port specifications.
* Left side
** Barrel jack for power, (with LED)
** USB 3, Type A
** USB 3, Type C
* Right side
** USB 2, Type A
** Standard headset jack
** MicroSD card slot

== Using the UART ==
[[File:PinePhone_Serial_Cable.png|400px|thumb|right|Pinout of the serial adapter. Swapping the tx and rx around from this also works and is more traditional. See the official [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pine64 document].]]

UART output is enabled by flipping the UART switch to the ON position (item 9). To do so you need to remove the Pinebook Pro's bottom cover - please follow [[Pinebook_Pro#Disassembly_and_Reassembly|proper disassembly and reassembly protocol]]. The OFF position is towards the touchpad, the ON position is towards the display hinges.

With the UART switch in the ON position, console is relayed via the audiojack and the laptop's sound is turned OFF. Please ensure that you are using a 3.3 V interface (such as the CH340, FTDI-232R, or PL2303, which are sold in both 3.3 V and 5 V variants) to avoid damage to the CPU. Older version of the serial console cable sold by Pine64 uses wrong voltage level and should not be used; see [https://forum.pine64.org/showthread.php?tid=9367 this forum thread] for further information. Recent version of the same cable uses the right voltage level.

Insert the USB plug of the cable into an open USB port on the machine which will monitor, ensuring that the audio jack of the serial cable is be fully inserted into the Pinebook Pro audio port. Run the following in a terminal:

<code>
$ lsusb
</code>

you should find a line similar to this:

<code>
Bus 001 Device 058: ID 1a86:7523 QinHeng Electronics HL-340 USB-Serial adapter
</code>

Serial output should now be accessible using screen, picocom or minicom (and others).
Examples:

<code>
screen /dev/ttyUSB0 1500000

picocom /dev/ttyUSB0 -b 1500000

minicom -D /dev/ttyUSB0 -b 1500000</code>

Old versions of U-Boot do not use the UART for console output. <strike>The console function is activated by the Linux kernel. Thus, if you use a non-Pinebook Pro Linux distro and want the UART as a console, you have to manually enable it.</strike>

== Using the optional NVMe adapter ==
The optional NVMe adapter allows the use of M.2 cards that support the NVMe standard, (but not SATA standard). The optional NVMe M.2 adapter supports '''M''' & '''M'''+'''B''' keyed devices, in both 2242 & 2280 physical sizes, the most common ones available. In addition, 2230 & 2260 are also supported, though NVMe devices that use those sizes are rare.

Once you have fitted and tested your NVMe drive, please add a note to this page [[Pinebook Pro Hardware Accessory Compatibility]] to help build a list of tried and tested devices.

Please see [[Pinebook Pro Troubleshooting Guide#NVMe SSD issues|a separate section]] that describes reported issues with the NVMe drives in PineBook Pro.

=== Installing the adapter ===
The V2.1-2019-0809 SSD adapter that shipped with the initial Pinebook Pro batches had significant issues. A repair kit will be shipped to address those issues.
(If necessary, it can be modified to work. There is [https://forum.pine64.org/showthread.php?tid=8322&pid=52700#pid52700 an unofficial tutorial on the forums] describing these modifications.)

The updated SSD adapter, labeled V2-2019-1107, takes into account the prior problems with touchpad interference. New orders as of Feb. 22nd, 2020 will be the updated adapter.

This is the link to the Pinebook Pro accessories in the store: [[https://pine64.com/?v=0446c16e2e66]]

Actual installation instructions are a work in progress. Unofficial instructions for installing V2-2019-1107 can be found [https://eli.gladman.cc/blog/2020/06/23/pine-book-pro-nvme.html here].

=== Post NVMe install power limiting ===
Some NVMe SSDs allow reducing the maximum amount of power. Doing so may reduce the speed, but it may be needed in the Pinebook Pro to both improve reliability at lower battery levels. And to reduce power used, to maintain battery life.
Here are the commands to obtain and change the power settings. The package 'nvme-cli' is required to run these commands. The example shows how to find the available power states, and then sets it to the lowest, non-standby setting, (which is 3.8 watts for the device shown);

<pre>$ sudo nvme id-ctrl /dev/nvme0
NVME Identify Controller:
...
ps 0 : mp:9.00W operational enlat:0 exlat:0 rrt:0 rrl:0
rwt:0 rwl:0 idle_power:- active_power:-
ps 1 : mp:4.60W operational enlat:0 exlat:0 rrt:1 rrl:1
rwt:1 rwl:1 idle_power:- active_power:-
ps 2 : mp:3.80W operational enlat:0 exlat:0 rrt:2 rrl:2
rwt:2 rwl:2 idle_power:- active_power:-
ps 3 : mp:0.0450W non-operational enlat:2000 exlat:2000 rrt:3 rrl:3
rwt:3 rwl:3 idle_power:- active_power:-
ps 4 : mp:0.0040W non-operational enlat:6000 exlat:8000 rrt:4 rrl:4
rwt:4 rwl:4 idle_power:- active_power:-

$ sudo nvme get-feature /dev/nvme0 -f 2
get-feature:0x2 (Power Management), Current value:00000000
$ sudo nvme set-feature /dev/nvme0 -f 2 -v 2 -s
set-feature:02 (Power Management), value:0x000002</pre>
Some NVMe SSDs don't appear to allow saving the setting with "-s" option. In those cases, leave off the "-s" and use a startup script to set the non-default power state at boot. 
If you want to test performance without saving the new power setting semi-permanantly, then leave off the "-s" option. 
 
There is another power saving feature for NVMes, APST, (Autonomous Power State Transitions). This performs the power saving & transitions based on usage. To check if you have a NVMe SSD with this feature;
<pre>$ sudo nvme get-feature -f 0x0c -H /dev/nvme0</pre>
Information for this feature, (on a Pinebook Pro), is a work in progress.

=== Using as data drive ===
As long as the kernel in use has both the PCIe and NVMe drivers, you should be able to use a NVMe drive as a data drive. It can automatically mount when booting from either the eMMC or an SD card. This applies to Linux, FreeBSD, and Chromium, using the normal partitioning and file system creation tools. Android requires testing.

=== Using as OS root drive ===
The SoC does not include the NVMe boot code, so the NVMe is not in the SoC's boot order. However, using the [https://github.com/mrfixit2001/updates_repo/blob/v1.1/pinebook/filesystem/mrfixit_update.sh U-Boot update script] from the mrfixit2001 Debian or [https://pastebin.com/raw/EeK074XB Arglebargle's modified script], and [https://github.com/pcm720/rockchip-u-boot/releases the modified u-boot images] provided by forum user pcm720, you can now add support to boot from an NVMe drive. Binary images are useable with SD, eMMC, and [[Pinebook_Pro_SPI|SPI flash]]. For OS images using the mainline kernel, there are a few variants of U-Boot available that also support NVMe as the OS drive. Though these may require writing the U-Boot to the SPI flash for proper use of the NVMe as the OS drive.

The current boot order, per last testing, for this modified U-Boot is:
*MicroSD
*eMMC
*NVMe

For more information, please refer to [https://forum.pine64.org/showthread.php?tid=8439&pid=53764#pid53764 the forum post.]

It is also possible to initially boot off an eMMC or SD card, then transfer to a root file system on the NVMe. Currently, it is necessary to have the U-Boot code on an eMMC or SD card. (A forum member [https://forum.pine64.org/showthread.php?tid=8439 posted here] about using a modified version of U-Boot with NVMe drivers, that uses <code>/boot</code> and <code>/</code> off the NVMe drive. So this may change in the future.)

Please see [[Pinebook_Pro#Bootable Storage|Bootable Storage]].

== Caring for the PineBook Pro ==
=== Bypass Cables ===
The mainboard features two (disconnected by default) bypass cables that are only to be used with the battery disconnected. The female (10) male (6) ends of the bypass cables can be connected to provide power to the mainboard if you need to run the laptop without a battery. Please refer to this [https://files.pine64.org/doc/PinebookPro/PinebookPro_Engineering_Notice.pdf engineering notice].

'''Note that despite the bypass cable being a two conductor cable, it is only used as one. Both wires being soldered together on either side is normal!'''

{{warning|Do not connect the bypass cables with the battery connected. Using the bypass cables with the battery connected can permanently damage the computer.}}

=== Pinebook Service Step-by-Step Guides ===

Under [[Pinebook_Service_Step_by_Step_Guides|Service Guides for Pinebook]] you can find instructions guides concerning disassembly of:

* The installation process on Pinebook Pro similar to 14" Pinebook
* The installation process is the reverse order of removal guide:
** 14″ Pinebook Lithium Battery Pack Removal Guide
** 14″ Pinebook LCD Panel Screen Removal Guide
** 14″ Pinebook eMMC Module Removal Guide

== Using the SPI flash device ==

See [[Pinebook Pro SPI]] for details.

The Pinebook Pro comes with a 128Mbit, (16MByte), flash device suitable for initial boot target, to store the bootloader. The SoC used on the Pinebook Pro boots from this SPI flash device first, before eMMC or SD card. At present, April 19, 2020, the Pinebook Pros ship without anything programmed in the SPI flash device. So the SoC moves on to the next potential boot device, the eMMC. ARM/ARM64 computers do not have a standardized BIOS, yet.

Here is some information on using the SPI flash device:

* You need the kernel built with SPI flash device support, which will supply a device similar to: code>/dev/mtd0</code>
* The Linux package below, will need to be available: <code>mtd-utils</code>
* You can then use this program from the package to write the SPI device: <code>flashcp <filename> /dev/mtd0</code>

Even if you need to recover from a defective bootloader written to the SPI flash, you can simply short pin 6 of the SPI flash to GND and boot. This will render the SoC bootrom unable to read from the SPI flash and have it fall back to reading the bootloader from other boot media like the eMMC or Micro SD card.

The procedures described above are a lot less risky than attaching an external SPI flasher and do not require any additional hardware. At present, April 19th, 2020, there is no good bootloader image to flash into the SPI flash device. This is expected to change, as there are people working on issue.

= Software tuning guide =
Details on how to get the most out of a Pinebook Pro & its RK3399 SoC.

== Customizing the Pinebook Pro's default Manjaro KDE system ==
=== Watching DRM content (Netflix, etc.) ===
Most paid online streaming services use Widevine DRM to make their content more difficult to pirate. Widevine is not directly supported on Manjaro KDE, however it is still possible to watch DRM content via the "chromium-docker" package which downloads a 32-bit ARM container and installs Chromium with Widevine inside of that. While not space-efficient, or efficient in general, it's the recommended solution for watching this content on your Pinebook Pro. You can install this package with:
<pre>sudo pacman -Sy chromium-docker</pre>

=== Checking GPU capabilities ===
To see what versions of OpenGL and OpenGL ES are supported by the Pinebook Pro, what driver is in use, and what version of the driver is loaded, install the "mesa-demos" package with:
<pre>sudo pacman -Sy mesa-demos</pre>
And then run:
<pre>glxinfo | grep OpenGL</pre>
This will give detailed information about your graphics card and driver, useful for debugging.

=== Better GPU compatibility and performance ===
For better graphics performance, you may install the "mesa-git" package, built and supplied in the Manjaro ARM repos. This lets you bring in the latest features, optimizations, and bugfixes for the graphics driver used by the Pinebook Pro. Installation is as simple as:
<pre>pacman -Sy mesa-git</pre>
Then you may reboot to load the newer driver.

With Mesa 20.2 there is no longer much reason to use this over the standard mesa package, and applications may occasionally break with mesa-git.

[https://docs.mesa3d.org/bugs.html Reporting bugs] to the Mesa project will help make sure any problems are quickly fixed.

=== OpenGL 3.3 support ===
By default, with the current state of the Panfrost GPU driver, the Pinebook Pro supports OpenGL 2.1 and OpenGL ES 3.0. If you want to use OpenGL 3.3, you need to set the system-wide environment variable, open the '''/etc/environment''' file with:
<pre>kate /etc/environment</pre>
And then at the bottom of the file, on a new line, add:
<pre>PAN_MESA_DEBUG="gl3"</pre>
Then save the file, entering your password when prompted, and reboot the system. When you check your GPU capabilities, it should report OpenGL 3.3 and applications that rely on it should function properly. Note that GL 3.3 support is incomplete and some rendering features do not work yet, notably geometry shaders.

=== Install Anbox on Pinebook Pro Manjaro 20.10 ===
[https://www.youtube.com/watch?v=EU8_Q11dATs Youtube video on installing Anbox on Pienbook Pro Manjaro Build 20.10 by LivingLinux]

== Customizing the Pinebook Pro's previously-default Debian system ==
Here are some hints on what you can do to customize the Pinebook Pro's previous factory image (aka [https://github.com/mrfixit2001/debian_desktop mrfixit2001 debian build])

=== Initial user changes, password, name, etc ===
When you first get your Pinebook Pro, you should consider setting strong passwords and making the default account your own.

* Reboot (this is just to ensure all background processes belong to the user are not running... there are other ways to achieve this but this way is easy)
* Once the machine reboots press Alt-Ctrl-F1 to bring up a text terminal
* Login as root (login: root, password: root)
* Set a strong password for the root user using the following command and it's prompts:
<pre># passwd (and follow prompts)</pre>
* Rename the rock user to your prefered username (replace myself with whatever you like):
<pre># usermod -l myself -d /home/myself -m rock</pre>
* Rename the rock group to match your preferred username:
<pre># groupmod -n myself rock</pre>
* Put your name in the account, (replace "John A Doe" with your name):
<pre># chfn -f "John A Doe" myself</pre>
* Set a strong password for the normal user:
<pre># passwd myself</pre>
* Log out of the text terminal:
<pre># logout</pre>
* Press Alt-Ctrl-F7 to go back to the login screen and then login as the normal user
* Open text terminal to fix login error: "Configured directory for incoming files does not exist";
<pre>$ blueman-services</pre>
Select "Transfer" tab and set "Incoming Folder" to myself
OR
If adduser is in distro, this is MUCH easier
sudo adduser $USER ,, fill out requested data
Then,, sudo adduser $USER $GROUP,,, 1 group at a time
To see which groups to add,,, id $USER, id rock

=== Changing the default hostname ===
Debian 9 has a command to allow you to change the hostname. You can see the current settings using;
<pre>$ sudo hostnamectl
Static hostname: Debian-Desktop
Icon name: computer
Machine ID: dccbddccbdccbdccbdccbdccbdccbccb
Boot ID: ea99ea99ea99ea99ea99ea99ea99ea99
Operating System: Debian GNU/Linux 9 (stretch)
Kernel: Linux 4.4.210
Architecture: arm64</pre>
To change, use this, (with "My_Hostname" used as the example);
<pre>$ sudo hostnamectl set-hostname My_Hostname</pre>
Whence done, you can re-verify using the first example.

Then you should backup and edit your <code>/etc/hosts</code> entry's name;
<pre>$ sudo cp -p /etc/hosts /etc/hosts.`date +%Y%m%d`
$ sudo vi /etc/hosts
127.0.0.1 localhost
127.0.0.1 My_Hostname
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
127.0.1.1 linaro-alip</pre>

=== Disable Chromium browser's prompt for passphrase & password storage ===

Perform the following steps:

* On the tool bar, hover over the Chromium icon
* Using the right mouse button, select '''Properties'''
* In the '''Command:''' line section, add <code>--password-store=basic</code> before the <code>%U</code>
* Use the '''x Close''' button to save the change
This will of course, use basic password storage, meaning any saved passwords are not encrypted. Perfectly fine if you never use password storage.

=== Changing the boot splash picture ===

The default boot splash picture can be replaced using the following instructions:

* Install '''ImageMagick''' which will do the conversion
<pre>$ sudo apt-get install imagemagick</pre>
* Create a 1920 x 1080 picture. For the best results, use a PNG image (It supports lossless compression).
* From the directory in which your new image is stored run the following commands
* Convert your image to the bootsplash raw format using imagemagick convert.
<pre>$ convert yoursplashimage.png -separate +channel -swap 0,2 -combine -colorspace sRGB RGBO:splash.fb</pre>
* Create a backup copy of your current splash screen
<pre>$ sudo cp /usr/share/backgrounds/splash.fb /usr/share/backgrounds/splash_original.fb</pre>
* Copy your new splash screen into place
<pre>$ sudo cp splash.fb /usr/share/backgrounds/splash.fb</pre>
* Set the correct permissions on the splash.fb file
<pre>$ sudo chmod 644 /usr/share/backgrounds/splash.fb</pre>
* If you do not want to see kernel console text messages, make sure you don't have '''Plymouth''' installed

=== Watching Amazon Prime videos with Chromium ===
When you create a new user, it will be necessary to launch the Chromium browswer with a specific user agent like below;
<pre>chromium-browser --user-agent="Mozilla/5.0 (X11; CrOS armv7l 6946.63.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36"</pre>
There may be more tweaks needed.

=== Enabling text boot time messages ===

By default, most Linux distros have a boot screen with a picture. To see all the boot time messages, use one of the following;

==== Debian ====
* Backup and edit the U-Boot configuration file:

cp -p /etc/default/u-boot /etc/default/u-boot.`date +%Y%m%d`
chmod a-w /etc/default/u-boot.`date +%Y%m%d`
vi /etc/default/u-boot

Remove the '''quiet''' and '''splash''' parameters. Leave everything else alone.

* Update the U-Boot configuration:

u-boot-update

* Test and verify you get what you think you should be seeing.

==== Manjaro ====
* Backup and edit the U-Boot configuration file:

cp -p /boot/extlinux/extlinux.conf /boot/extlinux/extlinux.conf.`date +%Y%m%d`
chmod a-w /boot/extlinux/extlinux.conf.`date +%Y%m%d`
vi /boot/extlinux/extlinux.conf

* Change '''console=ttyS2,1500000''' to '''console=tty1'''
* Remove the '''bootsplash.bootfile''' option and it's parameter.
* You can add verbose logging by appending '''ignore_loglevel''' to the line where boot splash was.
* Leave everything else alone.
* Test and verify you get what you think you should be seeing.

== Improving readability ==

Some people find that a 14" LCD screen with 1080p, (1920 x 1080), has text and icons a bit too small. There are things you can do to make the screen easier to use and read. 
* Increase the font size
* Use a font with more pronounced features
* Increase the various window manager sizes (e.g. increase the height of the tool bar)
* Change the color scheme to be easier on the eyes. Higher contrast can help usability.
* Change the window manager's decorations (e.g. use larger icons)
* Use a workspace manager, with one application per workspace
* When at home or office, use an external monitor
* Change the X-Windows DPI. One such method that someone used successfully, is: <blockquote><code>echo "Xft.dpi: 150" >> ~/.Xresources</code></blockquote>Change the 150 as desired to get the size adjustment you want.
 
However, do not change the resolution of the LCD screen, otherwise you may end up with a blank / black screen. If that happens, see this troubleshooting section for the fix: 
[[Pinebook_Pro#After_changing_builtin_LCD_resolution.2C_blank_screen|Blank screen after changing builtin LCD resolution]]

== Chromium tweaks ==

=== Flags ===

From the [https://github.com/mrfixit2001/updates_repo/blob/v1.8/pinebook/filesystem/default official Debian image]:

<pre>
--disable-low-res-tiling \
--num-raster-threads=6 \
--profiler-timing=0 \
--disable-composited-antialiasing \
--test-type \
--show-component-extension-options \
--ignore-gpu-blacklist \
--use-gl=egl \
--ppapi-flash-path=/usr/lib/chromium-browser/pepper/libpepflashplayer.so \
--ppapi-flash-version=32.0.0.255 \
--enable-pinch \
--flag-switches-begin \
--enable-gpu-rasterization \
--enable-oop-rasterization \
--flag-switches-end
</pre>

Note that in some cases, this may also decrease performance substantially, as observed when using these flags on the Manjaro KDE desktop. Feel free to experiment to find what is smoothest for you personally.

== gVim has performance issue ==
It appears that using GTK3 can cause very slow scrolling, while Vim in a terminal window works fine. 
Simply revert back to using GTK2, (how to do so is somewhat Linux distro-specific).

Another solution may be to run gVim with

GDK_RENDERING=image

environment variable set. It seems that this improves the performance by reverting back to software-only rendering.

== Kernel options ==
Here are some Pinebook Pro & its RK3399 SoC Linux specific options. If kernel version, (or version range specific), it should list that information in the description.

To see if a specific feature is enabled in the current kernel, you can use something like this;

<pre>
$ zgrep -i rockchip_pcie /proc/config.gz
# CONFIG_ROCKCHIP_PCIE_DMA_OBJ is not set
CONFIG_PHY_ROCKCHIP_PCIE=m
</pre>
If it's listed as <code>=m</code>, then it's a module. You can see if the module is loaded with;
<pre>
$ lsmod | grep -i rockchip_pcie
phy_rockchip_pcie 16384 0
</pre>
Note modules are not loaded until needed. Thus, we sometimes check the kernel configuration instead to see if a feature is configured first, then see if it's a module.

=== Hardware video decoding ===
Here is a method to check for hardware video decoding by the VPU. There are special Linux kernel modules that perform this function. 
Older systems, such as the previously-default Debian desktop, use the Rockchip-supplied kernel module <code>rk-vcodec</code>. To check, something like this can be used:
<pre>
$ lsmod | grep rk-vcodec
or
$ zgrep RK_VCODEC /proc/config.gz
CONFIG_RK_VCODEC=y
</pre>
Note that in the above example, the Rockchip video CODEC is not built as a module, but included into the kernel. Thus, it does not show up in the list modules check. 
 

Newer systems may use a different option as in the configuration below:
<pre>
$ zgrep HANTRO /proc/config.gz
CONFIG_VIDEO_HANTRO=m
CONFIG_VIDEO_HANTRO_ROCKCHIP=y
</pre>

= Troubleshooting guide =

Do not panic if something goes wrong or in an unexpected way. Instead, stop and consider carefully how to undo something, or how to redo it. This particularly applies when flashing a new operating system, or flashing new firmware to the keyboard or touchpad. If everything fails, consider reporting the issue on the forums, with as many relevant details as available.

Please, have a look at the [[Pinebook Pro Troubleshooting Guide]], which details a number of issues you may encounter.

= Hardware/Accessory Compatibility =
Please contribute to the [[Pinebook Pro Hardware Accessory Compatibility|hardware/accessory compatibility page]], which lists the status of hardware tested with the Pinebook Pro. Available hardware categories include the following:

* [[Pinebook Pro Hardware Accessory Compatibility#NVMe SSD drives|NVMe SSD drives]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB hardware|USB hardware]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB C alternate mode DP|USB-C alternate mode DP]]
* [[Pinebook Pro Hardware Accessory Compatibility#Other hardware|Other hardware]]

= Technical Reference =
== Disassembly and Reassembly ==
[[File:Standoffs.png|400px|thumb|right|Pinebook Screw stand-offs correct placement and location]]

[[File:Hinges_cover_removed_1.jpeg|300px|thumb|right|Hinge area of the Pinebook Pro lid with the cover removed]]
[[File:Hinges_cover_removed_2.jpeg|300px|thumb|right|Close-up of a Pinebook Pro lid hinge]]

There are a few '''mandatory''' precautions to be taken:

* Do not open the laptop by lifting the lid while the Pinebook Pro bottom cover is removed - this can cause structural damage to the hinges and/or other plastic components of the chassis such as the IO port cut-outs.
* When removing the back cover plate, *do not, under any circumstances, slide your fingertips between the metal shell and the plastic frame!* The back cover plate edges are sharp, and when combined with the pressure and movement generated from, specifically, attempting to slide the tips of your fingers along the bottom edge of the plate along the lid-hinge, they *will* slice open the tips of your fingers like a knife.
* When removing the back cover plate, use care to avoid damaging the speakers. They can be stuck to the back cover with double-sided tape, and the thin wires are very delicate. Newer Pinebook Pro laptops (as of the May 2021 batch, and perhaps earlier) seem to lack the double-sided tape to the rear cover, instead opting for tape or glue that makes them stick to the front cover. Nevertheless, be gentle when removing the back cover.

[[File:PinebookProScrewGuide.png|400px|thumb|right|Pinebook Pro external screws (this particular unit has suffered damage on screw (4)L)]]

When disassembling the laptop make sure that it is powered off and folded closed. To remove the bottom cover of the Pinebook Pro, first remove the ten (10) Phillips head screws that hold the bottom section of the laptop in place. There are four (4) short screws along the front edge, and six (6) long screws along the 3 remaining sides. Remove the cover from the back where the hinges are situated by lifting it up and away from the rest of the chassis. The aluminum case is held on only by screws. There are no plastic snaps, and the shell should pull away without any effort. If you experience any resistance at all stop and ensure all ten (10) screws are accounted for.

During reassembly, make sure that the back-screw standoffs are in place and seated correctly. Before replacing the aluminum back-plate, ensure that the speakers are properly seated by pressing gently on the hard plastic edge of the speaker module. Slide the bottom section into place so it meets the front lip of the keyboard section. Secure the front section (where the touchpad is located) in place using the short screws in the front left and right corners. Then proceed to pop in the bottom panel into place. Secure the bottom section (where hinges are located) by screwing in the left and right corners. Then screw in the remaining screws and run your finger though the rim on the chassis to make sure its fitted correctly. Note that the front uses the remaining 4 short screws.

The screws are small and should only be finger tight. Too much force will strip the threads. If after installing screws the back cover plate has not seated properly on one side (which may be caused by the aforementioned misseating of the speakers), open the display and hold the base on either side of the keyboard and gently flex the base with both hands in opposing directions. Once the side pops further in, then recheck the screws on that side. If it does not pop back in, re-open the machine and check for misseated components.

A basic 3D model to print replacement standoffs for the back cover screws is [https://www.thingiverse.com/thing:4226648 available on Thingiverse], until the official drawings or 3D models are made available.

====Display Disassembly====
It is not recommended to adjust the position of the lid when the bottom cover is removed, because the bottom cover provides structural strength, so the lid should be open fully as the first step, before starting any disassembly of the laptop. After opening the lid, remove the bottom cover by following the instruction found in the section above. Alternatively, you can keep the lid closed and remove the screws that hold the hinges to the main laptop body, as described in [[Pinebook Service Step by Step Guides]].

Parts of the hinge mechanism, as well as the screws that hold the hinges to the lid, are hidden behind an elongated plactic U-shaped cover that snaps in place using latches. Use a dedicated plastic prying tool or a guitar pick to gently pry the cover and remove it, starting from the outer edge. Once you pry the cover to a certain extent, it should be possible to remove it fully using only your hands. The U-shaped cover is rather sturdy, but still be careful not to break or bend it.

There are two small screws hidden underneath the two small rubber nubs on the upper part of the screen bezel, so first gently remove the nubs and then remove the screws. The screen bezel is held in place with a combination of latches and some adhesive tape, which is there to prevent dust ingress. The adhesive isn't very strong, and the bezel is capable of flexing back into shape after being twisted to a certain extent. There is more adhesive on the bottom part of the screen bezel, so be more careful while prying that section apart. Use the same prying tool that you used for the U-shaped cover, and work it around the outer edges of the screen bezel.

== Internal Layout ==

=== Main chips ===
* RK3399 system-on-chip (1)
* LPDDR4 SDRAM (21)
* SPI NOR flash memory (29)
* eMMC flash memory (26)
* WiFi/BT module (27)

=== Mainboard Switches and Buttons ===
There are two switches on the main board: disabling the eMMC (24), and enabling UART (9) via headphone jack.

The Reset and Recovery buttons (28): the reset button performs an immediate reset of the laptop. The Recovery button is used to place the device in maskrom mode; this mode allows flashing eMMC using Rockchip tools (e.g. rkflashtools).

[[File:PBPL_S.jpg]]

=== Key Internal Parts ===
{| class="wikitable"
|+ Numbered parts classification and description
! Number
! Type
! Descriptor
|-
! scope=row | 1
| Component || RK3399 System-On-Chip
|-
! scope=row | 2
| Socket || PCIe x4 slot for optional NVMe adapter
|-
! scope=row | 3
| Socket || Speakers socket
|-
! scope=row | 4
| Socket || Touchpad socket
|-
! scope=row | 5
| Component || Left speaker
|-
! scope=row | 6
| Connector || Power bridge connector
|-
! scope=row | 7
| Socket || Keyboard Socket
|-
! scope=row | 8
| Component || Optional NVMe SSD adapter
|-
! scope=row | 9
| Switch || UART/Audio switch - outputs UART via headphone jack
|-
! scope=row | 10
| Socket || Power bridge socket
|-
! scope=row | 11
| Socket || Battery socket
|-
! scope=row | 12
| Component || Touchpad
|-
! scope=row | 13
| Component || Battery
|-
! scope=row | 14
| Component || Right speaker
|-
! scope=row | 15
| Socket || MicroSD card slot
|-
! scope=row | 16
| Socket || Headphone / UART jack
|-
! scope=row | 17
| Socket || USB 2.0 Type A
|-
! scope=row | 18
| Socket || Daughterboard-to-mainboard ribbon cable socket
|-
! scope=row | 19
| Cable || Daughterboard-to-mainboard ribbon cable
|-
! scope=row | 20
| Component || microphone
|-
! scope=row | 21
| Component || LPDDR4 RAM
|-
! scope=row | 22
| Socket || Mainboard-to-daughterboard ribbon cable socket
|-
! scope=row | 23
| Socket || Microphone socket
|-
! scope=row | 24
| Switch || Switch to hardware disable eMMC
|-
! scope=row | 25
| Antenna || BT/WiFI antenna
|-
! scope=row | 26
| Component || eMMC flash memory module
|-
! scope=row | 27
| Component ||BT/WiFi module chip
|-
! scope=row | 28
| Buttons || Reset and recovery buttons
|-
! scope=row | 29
| Component || SPI flash storage
|-
! scope=row | 30
| Socket || eDP LCD socket
|-
! scope=row | 31
| Socket || Power in barrel socket
|-
! scope=row | 32
| Socket || USB 3.0 Type A
|-
! scope=row | 33
| Socket || USB 3.0 Type C
|}

=== Smallboard detailed picture ===

[[File:Pinebook_pro_smallboard.jpg]]

== Bootable Storage ==

=== Boot sequence details ===
The RK3399's mask 32KB ROM boot code looks for the next stage of code at byte off-set 32768, (sector 64 if using 512 byte sectors). This is where U-Boot code would reside on any media that is bootable. 
[[RK3399_boot_sequence|RK3399 boot sequence]]

=== Boot devices ===

The Pinebook Pro is capable of booting from eMMC, USB 2.0, USB 3.0, or an SD card. It cannot boot from USB-C. The boot order of the hard-coded ROM of its RK3399 SoC is: SPI NOR, eMMC, SD, USB OTG.

At this time, the Pinebook Pro ships with a Manjaro + KDE build with [https://www.denx.de/wiki/U-Boot/ u-boot] on the eMMC. Its boot order is: SD, USB, then eMMC.

(An update has been pushed for the older Debian + MATE build that improves compatibility with booting other OSes from an SD card. In order to update, fully charge the battery, establish an internet connection, click the update icon in the toolbar, and then reboot your Pinebook Pro. Please see [https://forum.pine64.org/showthread.php?tid=7830 this log] for details.)

Please note that PCIe, the interface used for NVMe SSD on the Pinebook Pro, is not bootable on the RK3399 and therefore is not a part of the boot hierarchy. It is possible to run the desired OS from NVMe by pointing extlinux on the eMMC to rootfs on the SSD. This requires uboot, the Kernel image, DTB, and extlinux.conf
in a /boot partition on the eMMC.

=== eMMC information ===
The eMMC appears to be hot-pluggable. This can be useful if trying to recover data or a broken install. Best practice is probably to turn the eMMC switch to off position before changing modules. Note that the enable/disable label on the silkscreen is incorrect on some board revisions (known bad on v2.1).

The eMMC storage will show up as multiple block devices:
*mmcblk1boot0 - eMMC standard boot0 partition, may be 4MB
*mmcblk1boot1 - eMMC standard boot1 partition, may be 4MB
*mmcblk1rpmb - eMMC standard secure data partition, may be 16MB
*mmcblk1 - This block contains the user areas

Only the last is usable as regular storage device in the Pinebook Pro.
The device number of "1" shown above may vary, depending on kernel.

If the eMMC module is enabled after boot from an SD card, you can detect this change with the following commands as user "root";
<pre>
echo fe330000.mmc >/sys/bus/platform/drivers/sdhci-arasan/unbind
echo fe330000.mmc >/sys/bus/platform/drivers/sdhci-arasan/bind
</pre>

(Note: with the device trees coming with older kernels (Linux < 5.11), the device name may be fe330000.sdhci instead of fe330000.mmc)

== Case Dimensions and Data ==
* Dimensions: 329mm x 220mm x 12mm (WxDxH)
* Weight: 1.26Kg
* Screws
** Philips head type screws
** M2 flat head machine screws (measurements in mm)
** 4 x Small screws (used along the front edge): Head - 3.44, Thread Diameter - 1.97, Thread Length - 2.1, Overall length - 3.05
** 6 x Large screws: Head - 3.44, Thread Diameter - 1.97, Thread Length - 4.41, Overall Length - 5.85
* Rubber Feet
** 18mm diameter
** 3mm height
** Dome shaped

== SoC and Memory Specification ==
[[File:Rockchip_RK3399.png|right]]
* Based on Rockchip RK3399

=== CPU Architecture ===
* big.LITTLE architecture: Dual Cortex-A72 + Quad Cortex-A53, 64-bit CPU
** Full implementation of the ARM architecture v8-A instruction set (both AArch64 and AArch32)
** ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
** ARMv8 Cryptography Extensions
** VFPv4 floating point unit supporting single and double-precision operations
** Hardware virtualization support
** TrustZone technology support
** Full CoreSight debug solution
** One isolated voltage domain to support DVFS
* Cortex-A72 (big cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a72 Dual-core Cortex-A72 up to 2.0GHz CPU]
** Superscalar, variable-length, out-of-order pipeline
** L1 cache 48KB Icache and 32KB Dcache for each A72
** L2 cache 1024KB for big cluster
* Cortex-A53 (little cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a53 Quad-core Cortex-A53 up to 1.5GHz CPU]
** In-order pipeline with symmetric dual-issue of most instructions
** L1 cache 32KB Icache and 32KB Dcache for each A53
** L2 cache 512KB for little cluster
* Cortex-M0 (control processors):
** [https://developer.arm.com/ip-products/processors/cortex-m/cortex-m0 Cortex-M0 CPU]
** Two Cortex-M0 cooperate with the central processors
** Architecture: Armv6-M
** Thumb/Thumb2 instruction set
** 32 bit only

=== GPU Architecture ===
* [https://developer.arm.com/products/graphics-and-multimedia/mali-gpus/mali-t860-and-mali-t880-gpus ARM Mali-T860MP4 Quad-core GPU]
* The highest performance GPUs built on Arm Mali’s famous Midgard architecture, the Mali-T860 GPU is designed for complex graphics use cases and provide stunning visuals for UHD content.
* Frequency 650MHz
* Throughput 1300Mtri/s, 10.4Gpix/s
* Graphic interface standards:
** OpenGL® ES 1.1, 1.2, 2.0, 3.0, 3.1, 3.2. (Panfrost has initial support of 3.0 beginning 2020/02/27)
** Vulkan 1.0, using the Mali binary blob. (Panfrost does not support Vulkan as of 2020/06/24)
** OpenCL™ 1.1, 1.2
** DirectX® 11 FL11_1
** RenderScript™

=== System Memory ===
* RAM Memory:
** LPDDR4
** 800MHz, (limited by RK3399)
** Dual memory channels on the CPU, each 32 bits wide
** Quad memory channels on the RAM chip, each 16 bits wide, 2 bonded together for each CPU channel
** 4GB as a single 366 pin mobile RAM chip
* Storage Memory:
** 64GB eMMC module, can be upgraded to an 128GB eMMC module. (The initial PINE64 community build version shipped with a 128GB eMMC.)
** eMMC version 5.1, HS400, 8 bit on RK3399 side
** Bootable
* SPI flash:
** [[Pinebook Pro SPI]]
** 128Mbit / 16MByte
** 1 bit interface
** Bootable, (first boot device, ahead of eMMC & SD card)
** U-Boot images can be made to work, but as of 2020/06/24 there is no standardized image available.

=== Video out ===
* USB-C Alt mode DP
* Up to 3840x2160 p60, dependant on adapter, (2 lanes verses 4 lanes)

=== Expansion Ports ===
* MicroSD card:
** Bootable
** Supports SD, SDHC and SDXC cards, up to 512GB tested. SDXC standard says 2TB is the maximum.
** Version SD3.0, (MMC 4.5), up to 50MB/s
** SD card Application Performance Class 1 (A1), (or better), recommended by some users, for better IOPS
* USB ports:
** 1 x USB 2.0 Type-A Host Port, bootable
** 1 x USB 3.0 Type-A Host Port, 5Gbps, is not bootable
** 1 x USB 3.0 Type-C OTG Port, 5Gbps, (includes laptop charging function), is not bootable
** Note that high power USB devices may not work reliably on a PBP. Or they may draw enough power to drain the battery even when the PBP is plugged into A.C. One alternative is externally powered USB devices.
* Headphone jack switchable to UART console mux circuit

== Additional hardware ==
Hardware that is not part of the SoC.

=== Battery ===
* Lithium Polymer Battery (10,000 mAH)

=== Display ===
* 14.0" 1920x1080 IPS LCD panel
=== Lid closed magnet ===
There is a magnet to detect when the laptop lid is closed, so action can be taken like sleep. This meets up with the Hall sensor on the daughter / small board to detect lid closed.
* The magnet is located on the LCD panel right side, around 1.5 inches up measure from bottom edge.

=== Webcam ===
* Internal USB attached Webcam

=== Audio ===
* 3.5mm stereo earphone/microphone plug
* Built-in microphone
* Built-in stereo speakers:
** Oval in design
** 3 mm high x 20 mm x 30 mm

=== Network ===
* WiFi:
** 802.11 b/g/n/ac
** Dual band: 2.4Ghz & 5Ghz
** Single antenna
* Bluetooth 5.0

=== Optional NVMe adapter ===
* PCIe 1.1, 2.5 GT/s per lane
** Note that due to errata, PCIe is limited to Gen1. See [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/arch/arm64/boot/dts/rockchip/rk3399.dtsi?id=712fa1777207c2f2703a6eb618a9699099cbe37b this commit].
* Four PCIe lanes, which can not be bifurcated, but can be used with one- or two-lane NVMe cards
* '''M''' keyed, though '''M'''+'''B''' keyed devices will work too
* Maximum length for M.2 card is 80mm (M.2 2280). The following sizes will also work: 2230, 2242, 2260
* Power: 2.5 W continuous, 8.25 W peak momentary
* Does not support SATA M.2 cards
* Does not support USB M.2 cards

== Pinebook Pro Schematics and Certifications ==
* Pinebook Pro Main Board Schematic And Silkscreen:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_mainboard_schematic.pdf Pinebook Pro Main Board ver 2.1 Schematic]
** [https://wiki.pine64.org/images/3/30/Pinebookpro-v2.1-top-ref.pdf Pinebook Pro ver 2.1 Top Layer Silkscreen]
** [https://wiki.pine64.org/images/b/b7/Pinebookpro-v2.1-bottom-ref.pdf Pinebook Pro ver 2.1 Bottom Layer Silkscreen]
* Pinebook Pro Daughter Board Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_daughterboard_schematic.pdf Pinebook Pro Daughter Board ver 2.1 Schematic]
* Optional Pinebook Pro NVMe Adapter Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_NVMe-adapter_schematic.pdf Pinebook Pro NVMe Adapter Board ver 2.1 Schematic]
* Serial Console Earphone Jack Pinout:
** [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pinkbook Serial Console Earphone Jack Pinout]
* Pinebook Pro Case:
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.pdf AutoCAD PDF File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.ai AutoCAD AI File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.dwg AutoCAD DWG File ]
* Pinebook Pro Certifications:
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20FCC%20Certificate-S19071103501001.pdf Pinebook Pro FCC Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20CE%20RED%20Certificate-S19051404304.pdf Pinebook Pro CE Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20ROHS%20Compliance%20Certificate.pdf Pinebook Pro RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3399 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2016/0419/758.html Rockchip RK3399 SoC Brief]
** [https://opensource.rock-chips.com/images/d/d7/Rockchip_RK3399_Datasheet_V2.1-20200323.pdf Rockchip RK3399 Datasheet v2.1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.4%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.4, part 1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.3, part 1] and [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part2.pdf part 2]
** [https://files.pine64.org/doc/datasheet/rockpro64/RK808%20datasheet%20V0.8.pdf Rockchip RK808 Datasheet v0.8]
* LPDDR4 SDRAM (366-pin BGA):
** [https://files.pine64.org/doc/datasheet/PinebookPro/micron%20SM512M64Z01MD4BNK-053FT%20LPDDR4%20(366Ball).pdf Micron 366 balls 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/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 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://wiki.pine64.org/images/b/b9/Ds-00220-gd25q127c-rev1-df2f4.pdf GigaDevice 128Mb SPI Flash Datasheet (updated)]
* Wireless and Bluetooth information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/AP6256%20datasheet_V1.7_12282018.pdf AMPAK AP6256 11AC Wi-Fi + Bluetooth5 Datasheet]
* Audio codec:
** [http://www.everest-semi.com/pdf/ES8316%20PB.pdf Everest ES8316 Audio Codec Datasheet]
* LCD panel:
** [https://files.pine64.org/doc/datasheet/PinebookPro/NV140FHM-N49_Rev.P0_20160804_201710235838.pdf 14" 1920x1080 IPS LCD Panel datasheet]
* USB-related information:
** Internal USB 2.0 hub: [https://wiki.pine64.org/images/3/39/GL850G_USB_Hub_1.07.pdf GL850G USB Hub Datasheet]
** USB Type-C Controller: [https://www.onsemi.com/pub/Collateral/FUSB302-D.PDF ON Semiconductor FUSB302 Datasheet]
* Touchpad information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/YX%20HK-9562%20HID%20I2C%20Specification.pdf PineBook Pro Touchpad Specification]
* Keyboard information:
** [https://wiki.pine64.org/images/b/b0/SH68F83V2.0.pdf Sinowealth SH68F83 Datasheet]
** US ANSI: XK-HS002 MB27716023
* Full HD camera sensor:
** [https://files.pine64.org/doc/datasheet/PinebookPro/HK-2145-263.pdf Full HD Camera module specification (in Chinese)]
** [https://files.pine64.org/doc/datasheet/PinebookPro/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GalaxyCore GC2145 Full HD Camera Sensor Datasheet]
* Battery-related information:
** Battery charging IC: [https://www.ti.com/lit/ds/symlink/bq24171.pdf?ts=1607068456825&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FBQ24171 Texas Instruments BQ24171 Datasheet]
** Battery monitoring IC: [https://cdn.datasheetspdf.com/pdf-down/C/W/2/CW2015-Cellwise.pdf Cellwise CW2015 Datasheet]
** [https://files.pine64.org/doc/datasheet/pinebook/40110175P%203.8V%2010000mAh规格书-14.pdf 10000mAH Lithium Battery Specification]
* Power path device:
** [https://wiki.pine64.org/images/9/99/Sis412dn.pdf N-MOS / MOSFET]
* NVMe adapter:
** [https://wiki.pine64.org/images/d/d0/Hirose-FH26W-35S-0.3SHW%2860%29-datasheet.pdf FH26-35S-0.3SHW flat flex connector (compatible, not OEM)]

== Versions ==
Pinebook Pro v1 and v2 were prototype models that did not make it to the public. The "first batch" (First 100 forum preorders) onward are v2.1. [https://forum.pine64.org/showthread.php?tid=8111]

=Skinning and Case Customization=
* Template files for creating custom skins. Each includes template layers for art placement, and CUT lines.
**[https://drive.google.com/open?id=1UKFlC53DO0GJm3Hz1E_669n_HhI45e4n Case Lid Template]
**[https://drive.google.com/open?id=1Q6bKGarMDhvWz3HdGvhL5qDhyHb546ve Case Bottom Template]
**[https://drive.google.com/open?id=1ugI74ygNJ3EN5jXks5jKvdpEAoxIzHo4 Case Palmrest Template]

= Other Resources =
* [https://forum.pine64.org/forumdisplay.php?fid=111 Pinebook Pro Forum]
* [https://forum.pine64.org/forumdisplay.php?fid=98 ROCKPro64 Forum]
* [https://riot.im/app/#/room/#pinebook:matrix.org Matrix Channel] (no login required to read)
* IRC Server: irc.pine64.org Channel: PineBook
* [https://discordapp.com/channels/463237927984693259/622348681538043924 Discord Channel]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [[Pinebook Pro/Freepascal and Lazarus IDE on Manjaro|Freepascal and Lazarus IDE on Pinebook Pro]]

[[Category:PineBook Pro]]
[[Category:Rockchip RK3399]]

Pinebook Pro Software Releases

2022-05-30T20:52:19Z

CameronNemo: /* Linux OS Image Releases */ Add Void Linux images

= 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/c/arm/ 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]]
As of Nov. 3rd, 2021, Pinebook Pro has No official support (CSC) from Armbian.

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 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]]

=== Official Installation ===
See [[Installing Arch Linux ARM On The Pinebook Pro]] for instructions on how to install the official Arch Linux ARM.

=== Customized Premade Image ===
Arch Linux ARM root filesystem customized for the Pinebook Pro using Manjaro kernel. 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/bpo/edge/pine64-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/stable/ 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-Bullseye.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]

Credits to [https://bugzilla.opensuse.org/show_bug.cgi?id=1194491]
Step 1. Flash Tow-Boot[https://github.com/Tow-Boot/Tow-Boot] to SPI
Step 2. Flash openSUSE image to sd card & insert it
Step 3. When it loads grub, press e and add the following line:

devicetree /boot/dtb/rockchip/rk3399-pinebook-pro.dtb

Press ctrl + x to boot

Work : display, wifi
Not tested : bluetooth
Doesn't work : audio

You may build rpms and see if it fix issues from this repository: [https://github.com/bengtfredh/pinebook-pro-copr]

== FydeOS ==
An operating system based on the Chromium Project

https://fydeos.io/download/device/pinebook-pro

== Void Linux ==

[https://voidlinux.org/ Void Linux] packages U-Boot and a kernel for the Pinebook Pro, but does not distribute any images for the device.

Cameron Nemo ([[User:CameronNemo]]) distributes unofficial Void Linux images for the Pinebook Pro:

* [https://repo.nohom.org/void/images/void-pinebookpro-20220530.img.xz glibc download]
* [https://repo.nohom.org/void/images/void-pinebookpro-musl-20220530.img.xz musl download]

Some notes about the images:

* They were released on 2022-05-30
* They ship U-Boot 2022.04 and Linux 5.15.44 (with minimal patches)
* Meant to be uncompressed then flashed to either an SD card or the internal eMMC module
* The root partition is ~1.7GB, and must be expanded manually
* There are very few services enabled on the images by default: udev and some getty's
* The default root password is "voidlinux"

= 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
* Display doesn't always work properly on first boot of installer, usually fixed after a couple tries
* 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 a functional bootloader, leaving the installed system in an unbootable state until it's manually added (if installed to eMMC, the system cannot be booted even to an SD card unless the eMMC is physically switched off or there is U-Boot in the SPI)

[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 consistently 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. Unfortunately, this script is not currently functional, and requires extensive troubleshooting to make work. New instructions are currently being created and will be available here.

'''Word to the wise'''

Currently, following the instructions on the Pinebook pro gentoo github page will *not* result in a functional system. Therefore it is neccesary to follow the instructions given here. Please bear in mind that the Pinebook pro's six arm cores and 4gb of ram are extremely anemic. For example, emerging the package net-libs/webkit-gtk in order to build the minimalist web-browser "surf", a process which takes eighty minutes on an intel core i5-8250U with 8gb of ram, required eight hours of compile time,
Basic installation alone can take 24 hours of compillation, dozens of reboots, and hours of troubleshooting. After that, even installing firefox would take 17 hours.
Now that that's out of the way, we may begin the installation.

'''Preparing the bootloader'''

Installing a functional bootloader can be difficult. Luckily, the tow-boot project provides a UEFI-like experience for some arm-based devices. Furthermore, it is not neccesary install this bootloader manually, as it will continue to be useable even after the disk has been reformatted, as long as the bootloader remains unscathed.

https://manjaro.org/downloads/arm/pinebook-pro/arm8-pinebook-pro-minimal/

No-matter where you intend to install gentoo, the bootloader should always be installed on the eMMC flash, although technically the SD card slot could also be used. Either way, install any of the official Manjaro arm disk images to the internal eMMC (there's no reason not to use the minimal image, as you will not be using this OS for anything). You may use a second operating system installed on an SD-card, or the official Pine64 eMMC USB adapter. Boot into this operating system to ensure that the bootloader functions, but after that you have no further need of it.

Next, if you already have an OS on an SD card, you can use that for installing gentoo. If you don't, you may be pleasantly suprised to find that tow-boot is cabable of booting from a USB drive. Therefore, you may install the same Manjaro image to your USB drive or SD card, and select it from the boot menu. You should now have an unused but bootable OS on the eMMC, and another bootable, usable OS on your external storage.

'''Preparing the Disks'''

Log into your host device as root with the following command:

<code> sudo su </code>

Enter your password.

Let the device on which you intend to install gentoo be refered to hereafter as /dev/<gentoo>. Use the following command to prepare this disk for installation:

<code> fdisk -B /dev/<gentoo> </code>

Note: don't just copy these commands! You should substitute <gentoo> for mmcblk2 for the internal eMMC flash storage.

Note that the first block of the boot partition is block 62500. Delete all partitions, but *do not* re-format the disk. Create a new boot partition starting at 62500, and as it's size select "+1GB". Create a new swap partition. fdisk will try to start it at the beginning of the volume (before the boot partition) Instead, when it prompts you for the starting position, enter in the end sector of the boot partition. It should then tell you that this is within an existing partition, and recommend a slightly higher value. Press enter, and give for the size of the partition any value greater than "+4gb". You need this much ram to be able to suspend your system, and emerge large packages. Don't be stingey - you still have SD cards. I reccomend "+8gb".
Finally, add a root partition starting at the end sector of the swap partition, and use the rest of the disk for it. That should be 50-60 GB depending on the size of your swap and boot partitions.

Lastly, press "t" to set the type of each partition. You may set partition 1 to type 6, 2 to type 82, and 3 to type 83.

to set the partition types of the three partitions.

<code>lsblk</code>

to remind yourself which disk is /dev/<gentoo>
Write the filesystems to these three partitions with the commands:

<code>mkfs.vfat /dev/<gentoo>p1

mkswap /dev/<gentoo>p2

mkfs.ext4 /dev/<gentoo>p3</code>

This may be a slightly different format if you're installing to a usb stick.

'''Installation'''

make the directory for mounting the filesystem you just created. These should be made on the external OS.

<code>mkdir /mnt/gentoo

mount /dev/<gentoo>p3 /mnt/gentoo</code>

cd into this directory and fire up links. Navigate to gentoo.org/downloads and select the stage 3 minimal stage 3 tarball. Download it to your current directory, or move it to that directory from wherever it has been downloaded to. Once you are in the correct directory, unpack the tarball.

<code>tar xpvf stage3-arm64-<blah blah blah></code>

Mount the boot partition.

<code>mount /dev/<gentoo>p1 /mnt/gentoo/boot</code>

Chroot into the mounted directory and Install the operating system as per the AMD64 manual [https://wiki.gentoo.org/wiki/Handbook:AMD64]. Before you emerge anything, however, be sure to set your use flags as follows:

<code>nano /etc/portage/make.conf</code>

<code>MAKEOPTS="-j4 -l4"

ACCEPT_KEYWORDS="* **"

ACCEPT_LICENSE="*"

USE="X gtk bluetooth pulseaudio"
</code>

You can use your own options instead of these if you know what you're doing. It's not super difficult.

Continue installing the operating system, but stop just before emerging the @world set. I don't know if this is necessary, but I haven't had the time to try without doing this. Clone Janikk2099's github repo. It doesn't matter where, and run the script. If it fails run it a couple more times.

<code>git clone https://github.com/Jannik2099/gentoo-pinebookpro

./gentoo-pinebookpro/prepare.sh</code>

Don't follow any of Janikk's other instructions. They appear to be out of date (no offense bro). Let me be clear: DO NOT INSTALL U-BOOT. I don't know what will happen, but it won't be an improvement over the existing boot-loader so don't worry about it.

Finish installing your system until you come to the kernel.

'''Custom Kernel'''

Use sys-kernel/gentoo-kernel-bin as your kernel. You will need to manually edit the kernel configuration. First, select it as your kernel.

<code>eselect kernel list</code>

This should list only one option. Otherwise, select the number matching <code>linux-5.<whatever is latest>-gentoo-dist</code>, and cd into the kernel source directory.

<code>eselect kernel set <number>

cd /usr/src/linux</code>

Begin the kernel configuration

<code>make menuconfig</code>

At this point, you're almost on your own. I don't know a strict cause-and-effect relationship between my kernel config and the behavior of my system. For starters, just go into platform selection and deselect everything except rockchip platforms. Once you're done save your configuration and exit. Make sure boot is mounted, and your fstab is set up with your swap mounted. Make sure dracut is installed.

<code>make

make modules

make dtbs

make install

make modules install

make dtbs_install

ls /lib/modules

dracut -f --kver <name of directory in /lib/modules matching your kernel, *not* the kernel name from eselect>
</code>

emerge the package extlinux and run <code>u-boot-update</code>. Open the extlinux configuration file.

<code>nano /boot/extlinux/extlinux.conf</code>

And configure it as follows:

LABEL <label of your choice, for example GENTOO ARM>

KERNEL /<name of your vmlinuz kernel image. Include the slash, but be relative to boot, not root.>

FDT /dtbs/<kernel-version>/rockchip/rk3399-pinebook-pro.dtb

APPEND initrd=/<name of initramfs image> root=PARTUUID-<nboot partition's PARTUUID, no quotes> rw rootwait
</code>

You can use the blkid command to find the PARTUUID of every partition on the machine. None of this configuration is guaranteed to work, but it worked for me, and given enough fiddling you can get it to work as well.

Now you should reboot the machine and see if it boots into gentoo. If it does: congratulations! If not, too bad. Try again.

== 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.

== Slackware ==

<div style=float:right>[[File:slackware.jpg|right|100px]]</div>

[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.

More information can be found about Slackware in this [https://www.youtube.com/watch?v=A5PFYUttsWA&list=PL1XOSJnvang3IbwySOf6m3PK1gm13hS5s 20 minute video].

[https://docs.slackware.com/slackwarearm:inst Installation instructions].

[https://www.youtube.com/watch?v=QKs_RnFqLO8&list=PL1XOSJnvang3VLmqke2QbRitKtOD6Rm3t Installation guide video]

[[Category:PineBook Pro]]

Quartz64 Development

2022-03-20T05:18:24Z

CameronNemo: include archived battery patch series

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=622542]
| <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&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
|-
! 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]]

Pinebook Pro

2022-01-23T02:35:48Z

CameronNemo: /* Basic summary of replacing keyboard */ Expand keyboard replacement section (M.2 board, antenna, bit sizes)

= User Guide =
== Introducing PineBook Pro ==
[[File:PBP.jpg|400px|thumb|right|Pinebook Pro running Debian with MATE]]

The Pinebook Pro is a Linux and *BSD ARM laptop from [https://www.pine64.org/ PINE64]

It is built to be a compelling alternative to mid-ranged Chromebooks that people convert into Linux laptops. It features an IPS 1080p 14″ LCD panel, a premium magnesium alloy shell, high capacity eMMC storage, a 10,000 mAh capacity battery, and the modularity that only an open source project can deliver.

It's compact and slim dimensions are 329mm x 220mm x 12mm (WxDxH).

Key features include: the RK3399 SOC; USB-C for data, video-out and power-in (3A 5V); privacy switches for the microphone, BT/WiFi module, and camera; and expandable storage via NVMe (PCIe x4) with an optional adapter.

The Pinebook Pro is equipped with 4GB LPDDR4 system memory, high capacity eMMC flash storage, and 128Mb SPI boot Flash. The I/O includes: 1 x micro SD card reader (bootable), 1 x USB 2.0, 1 x USB 3.0, 1 x USB type C Host with DP 1.2 and power-in, PCIe x4 for an NVMe SSD drive (requires an optional adapter), and UART (via the headphone jack by setting an internal switch).

The keyboard and touchpad both use the USB 2.0 protocol. The LCD panel uses eDP MiPi display protocol.

Many different Operating Systems (OS) are freely available from the open source community and partner projects. These include various flavors of Linux (Ubuntu, Debian, Manjaro, etc.) and *BSD.

== Software and OS Image Downloads ==

=== Default Manjaro KDE Desktop Quick Start ===

When you first get your Pinebook Pro and boot it up for the first time, it'll come with Manjaro using the KDE desktop. The Pinebook Pro is officially supported by the Manjaro ARM project, and support can be found on the [https://forum.manjaro.org/c/manjaro-arm/78 Manjaro ARM forums.]

On first boot, it will ask for certain information such as your timezone location, keyboard layout, username, password, and hostname. Most of these should be self-explanatory. Note that the hostname it asks for should be thought of as the "codename" of your machine, and if you don't know what it's about, you can make something up (use a single word, all lower case, no punctuation; e.g. "pbpro").

After you're on the desktop, be sure to update it as soon as possible and reboot after updates are finished installing. If nothing appears when you click on the Networking icon in your system tray to connect to your Wi-Fi, ensure the Wi-Fi [https://wiki.pine64.org/index.php/Pinebook_Pro#ANSI_Fn_.2B_F_keys_wrong_for_F9.2C_F10.2C_F11_and_F12 privacy switch] is not disabled.

=== Pinebook Pro images ===
Under [[Pinebook Pro Software Release]] you will find a complete list of currently supported Operating System images that work with the Pinebook as well as other related software.

The list includes OS images and descriptions of:

* [[PinebookPro_Software_Release#Manjaro ARM|Manjaro ARM]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Armbian|Armbian]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Twister OS|Twister OS]] (microSD Boot)
* [[PinebookPro_Software_Release#Fedora|Fedora]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Arch_Linux_ARM|Arch Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#postmarketOS|Postmarket OS]] (microSD and USB boot)
* [[PinebookPro_Software_Release#Kali Linux|Kali Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#DietPi|DietPi]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Q4OS|Q4OS]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#NetBSD|NetBSD]] (microSD and eMMC Boot)
* [[Pinebook_Pro_Software_Release#OpenBSD|OpenBSD release for ARM64]]
* [[Pinebook_Pro_Software_Release#Gentoo|Gentoo]]

== Keyboard ==
The Pinebook Pro is available in two keyboard configurations: ISO and ANSI. Both the keyboard and touchpad in the Pinebook Pro use the USB 2.0 protocol and show up as such in xinput. The keyboard features function (Fn) keys in the F-key row, which include display brightness controls, sound volume, touchpad lock, and other functionality. There is also a custom PINE64 logo key that functions as Menu/Super key. It has also a secondary functionality for setting the privacy switches.

The keyboard firmware binary can be flashed from userspace using the provided open source utility.

{{warning|DO NOT update the keyboard firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed, see the [https://reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Documentation for the keyboard can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]].

=== Typing special characters ===
The [[Wikipedia:British_and_American_keyboards#Other_keyboard_layouts|UK ISO Layout]] does not have dedicated keys for characters like the German umlauts (Ä,Ö,Ü, etc). Certain characters can still be generated by means of either key combinations or key sequences.
{| class="wikitable"
!Character
!Key combination/sequence
|-
|Ä, Ö, Ü, ä, ö, ü
|[[Wikipedia:AltGr_key|[AltGr]]]+'[' followed by [A], [O], [U], [a], [o] or [u]
|-
|µ
|[AltGr]+[m]
|-
|Ø, ø
|[AltGr]+[O], [AltGr]+[o]
|-
|@
|[AltGr]+[q] (as on the German layout)
|-
|ß
|[AltGr]+[s]
|-
|§
|[AltGr]+[S]
|-
|°
|[AltGr]+[)]
|}

=== Privacy Switches ===
There are three privacy switches mapped to the F10, F11 and F12 keys on the Pinebook Pro keyboard. They de/activate the following:

{| class="wikitable"
|+ Privacy switch function and description
! Combination
! Effect
! Description
! Notes
|-
! scope=row | PINE64 logo key+F10
| Microphone Privacy switch
| CAPs lock LED blinks. 2 blinks = enabled, 3 blinks = disabled
|-
! scope=row | PINE64 logo key+F11
| WiFi Privacy switch
| NUM lock LED blinks. 2 blinks = WiFi enabled / privacy switch disabled, 3 blinks = WiFi disabled / privacy switch enabled.
| '''Re-enabling requires reboot''' (or a [//forum.pine64.org/showthread.php?tid=8313&pid=52645#pid52645 command line hack to bind/unbind]).
|-
! scope=row | PINE64 logo key+F12
| Camera privacy switch
| CAPs lock and NUM lock LEDs blink together. 2 blinks = enabled, 3 blinks = disabled
| Can use tools like '''<code>lsusb</code>''' to detect camera's presence. If not detected, check privacy switch.
|}

'''(Press the PINE64 logo key plus F10/F11/F12) for 3 seconds)'''

The keyboard operates on firmware independent of the operating system. It detects if one of the F10, F11 or F12 keys is pressed in combination with the Pine key for 3 seconds. Doing so disables power to the appropriate peripheral, thereby disabling it. This has the same effect as cutting off the power to each peripheral with a physical switch. This implementation is very secure, since the firmware that determines whether a peripheral gets power is not part of the Pinebook Pro’s operating system. So the power state value for each peripheral cannot be overridden or accessed from the operating system. The power state setting for each peripheral is stored across reboots inside the keyboard's firmware flash memory.

=== Basic summary of replacing keyboard ===

This guide is very basic and should be fleshed out with (better) pictures. There just isn't a list of steps anywhere else yet.

Here's what the replacement keyboard looks like:

[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (front)]]
[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (back)]]

''Step 0'': If changing from ISO keyboard to ANSI keyboard, or vice versa, be sure to have a system capable of running the firmware updater that you can access either remotely or with a USB keyboard beyond the internal keyboard, as the firmware for each is very different and keys won't work correctly. See https://forum.pine64.org/showthread.php?tid=8407 (and for NetBSD, https://forum.pine64.org/showthread.php?tid=8716).

''Step 1'': The remove back back panel.

There are 10 screws on the back that must be removed, and the back panel detached. I recommend using a PH0 bit. The speakers may remain attached via glue to the case and should be carefully pried off. When this is done, taking photos of how everything looks now can help put it all back together later.

[[File:Pinebook_Pro_keyboard-replacement-screws.jpg|300px|Remove the back panel]]

''Step 2'': Places to unscrew.

There are 3 items screwed into the keyboard frame that must be removed. There are 2 large screws for daughter board, 3 large screws and 1 small screw for mainboard, and 4 small screws for battery. Be sure to not lose them. I recommend a PH00 bit for the large screws on the daughter and main boards and a PH1 bit for the small screws on the battery and mainboard.

[[File:Pinebook_Pro_new_keyboard-back-removed.jpg|300px|Remove the back panel]]

''Step 3'': Remove the battery.

Once the battery screws are removed, it should be unplugged from the mainboard and removed. Note that there are two unconnected cables lying around, that should remain unconnected. They are used when the battery is disconnected entirely.

[[File:Pinebook_Pro_new_keyboard-zoom-mainboard.jpg.jpg|300px|Zoom on the mainboard]]
[[File:Pinebook_Pro_new_keyboard-zoom-daughterboard.jpg|300px|Zoom on the daughterboard]]

''Step 4'': Unplug the ribbon cables.

NOTE: you should remove the M.2 adapter board now if you have one installed. See elsewhere in this wiki for instructions on how to install/remove that piece.

There are several ribbon cables. To remove, flip up the tab and gentle pull the ribbon out.

* One cable runs from the mainboard to the daughterboard underneath the battery. Detach from both ends. With the battery removed, detach from keyboard shell, and set aside for the new keyboard shell.
* One cable runs between the touchpad and the mainboard. Detach from both ends, and also set aside.
* One cable runs between the keyboard and the mainboard. This one remains attached to the keyboard and only needs to be detached from the mainboard.
* One cable from the LCD attaches near the lid hinge. It should be just unplugged.

''Step 5'': Detach microphone, speakers, and antenna.

[[File:Pinebook_Pro_microphone_removed.jpg|300px|thumb|right|One of the Pinebook Pro microphones after removal]]

The speakers, microphone, and antenna don't have to be detached from the mainboard, but they need to be detached from the keyboard shell. The microphones are held in place by tape, and the speakers have sticky sides. The speakers are found obviously, but the microphones (two of) can be found between the battery and the hinge area. Each microphone can be carefully pulled/wedged out of its position by a small screwdriver or pick. The antenna, similar to the microphones, is found near the hinge area and to the top left of the battery.

''Step 6'': Remove mainboard and daughterboard.

At this point, the mainboard and daughterboards should be removed. When unscrewed (see Step 2) they should pull out fairly easily. Put them aside (including microphones and speakers if left attached.)

[[File:Pinebook_Pro_new_keyboard-all-boards-removed.jpg|300px|All boards removed]]

''Step 7'': Detach the LCD panel.

Step 2 didn't tell you, there are 6 more screws to remove here, 3 for each of the hinges. I recommend a PH1 bit for these screws. Unscrew these and the LCD panel will be able to be removed. You may have to jiggle or move the hinges for this. When detached, be sure to place the LCD panel such that the display is protected.

[[File:Pinebook_Pro_new_keyboard-detached-display.jpg|300px|Display detached]]
[[File:Pinebook_Pro_new_keyboard-detached-display2.jpg|300px|Display detached (front)]]

''Step 8'': Try Not To Break Your Touchpad, or, How I Learned To Love Things That Bend

'''NOTE This section really feels like you're going to break something.'''

The touchpad is glued to the keyboard shell and it's glued well. There are two places it is glued to. If you can, only the middle must be force-detached. You will think you're going to break it. Gently apply increasing force until the glue begins to detach (you will hear a crackle as it comes off), and continue very slowly until the whole thing is detached. This may take minutes due to that feeling you're going to break it.

I found it helpful to lift the top left plastic bit on the keyboard to unstick that portion of the touchpad, then push on the top left portion of the touchpad to unstick the rest of the touchpad.

[[File:Pinebook_Pro_new_keyboard-touchpad1.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad2.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad3.jpg|300px|Unmouting the touchpad]]

''Step 9'': Over the hill, touchpad goes into new shell.

In the new keyboard shell put the touchpad back where it was, hopefully the glue will remain sufficiently attached. If there is a glue issue, this guide unfortunately has no advice currently.

[[File:Pinebook_Pro_new_keyboard-install-touchpad.jpg|300px|Install the touchpad]]

''Step 10'': Reattach the LCD panel.

The LCD panel should slot back into the keyboard frame, the same way it came out. If the hinges were moved, they should be *very* *gently* closed such that the LCD panel and keyboard closed like normal for the remaining steps.

''Step 11'': Tape it out.

Move any tape from the old keyboard shell to the new one. These items protect the mainboard and daughterboard, and keep various wires in their right place. Some are grey and some are black. For tape that holds the speakers, microhones, or their cables in place, do not reattach yet.

''Step 12'': Board install.

Install the mainboard, the daughtboard, and their connecting ribbon cable. Be sure to put the boards in place, 2 large flat screws for the daughterboard, 3 large flat screws and one small screw for the mainboard, before attempting to place the ribbon.

''Step 13'': Microphone, speaker, and antenna install.

Reattach the microphones, antenna, and speakers to their respective areas, making sure that both are properly oriented - the speaker "out" faces up, and the microphone cables as connected must face up (these are opposite directions.)

''Step 14'': Reattach other ribbon cables.

NOTE: this would be a good time to attach/install the M.2 adapter board if that is desired. See elsewhere in this wiki for those instructions.

The LCD panel, keyboard and touchpad ribbon cables should be reattached. Make sure the flap is open, insert the ribbon into the slot (a portion of the cable will disappear), and push the flap down. The cable should not be easy to pull out.

''Step 15'': Reattach the battery, and final re-tape.

The battery should be installed with the 4 screws holding it in place, and the connector attached to the mainboard. Be sure to keep the two other cables remain unconnected. Ensure all wires and other tapes are held in place.

''Step 16'': Reattach the back panel.

Put the back panel back on, and reattach the 10 screws.

''Step 17'': If you changed from ISO to ANSI or from ANSI to ISO, you'll need to update your firmware now. See the links in Step 0 above.

== Touchpad (trackpad) ==
Documentation for the touchpad can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]]. It is the only component of the Pinebook Pro held in place with strong adhesive tape. Here are some of its features:

* 2 actuating buttons.

* multi-touch functionality.

* A matte finish that your finger can slide along easily.

* A reasonable size (96mm × 64mm; diagonal: 115.378mm or 4.542”).

=== Troubleshooting ===

If you are having trouble using 2 fingers to scroll or emulate the click of a mouse's right-button, then try these solutions:

* Update the firmware.

* Keep your 2 fingers spread apart rather than close together.

* Individual programs might need to be configured specially.

:* For smooth scrolling and gestures under X-Windows, ''Firefox'' should be launched with with the following environment variable assignment:

::: <code>MOZ_USE_XINPUT2=1</code>

* Experiment with other settings, via [[#X-Windows Configuration|X-Windows Configuration]] or some other system preferences; for example, you could disable double-finger scrolling, and instead enable scrolling by sliding one finger along the edge of the touchpad.

=== Firmware ===
The touchpad controller is connected to the keyboard controller. All touchpad events go through the keyboard controller and it's software, then to the keyboard controller's USB port. Note that the touchpad does have separate firmware, (which has to be written through the keyboard controller). The touchpad vendor’s firmware binary can be flashed from userspace using the following open source command-line utility:

* Kamil Trzciński’s [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater pinebook-pro-keyboard-updater].

Naturally, forks have begun to appear:

* Jack Humbert’s [https://github.com/jackhumbert/pinebook-pro-keyboard-updater fork]

* Dragan Simic’s [https://github.com/dragan-simic/pinebook-pro-keyboard-updater fork]. This one has recently delivered a much improved firmware from the vendor, which greatly improves the control of the cursor (see this [https://forum.pine64.org/showthread.php?tid=14531 thread] for discussion); before installing this update, consider resetting to the defaults any configuration of your touchpad.

'''Every Pinebook Pro produced before September 2021 should have its keyboard and touchpad firmware updated.'''

{{warning| DO NOT update the touchpad firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed. See [//old.reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Before updating ''any'' firmware, your Pinebook Pro should be either fully charged or, preferably, running from mains. This utility will be writing data to chips on the keyboard and touchpad, so a loss of power during any stage of the update can result in irrecoverable damage to your touchpad or keyboard.

The scripts ought to work on all OSs available for the Pinebook Pro. Some OSs may, however, require installation of relevant dependencies. The instructions below assume a Debian desktop. To install these dependencies, newer Pinebook Pro models that come with Manjaro will require a different command.

There are two keyboard versions of the Pinebook Pro: ISO and ANSI. You need to know which model you have prior to running the updater.
Firmware update steps for both models are listed below.

What you will need:

* Connection to WiFi (for getting dependencies).

* Your Pinebook Pro fully charged or running from mains power.

* An external USB keyboard & mouse (or access to the Pinebook Pro via SSH. Please note that for some configurations, the SSH service might not be available without first having logged in once; in this case, you will definitely want at least an external keyboard).

==== ISO Model ====

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 iso
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 iso
sudo poweroff # do not use 'reboot'
</pre>

==== ANSI Model ====

{{Hint| Note: Running step 1 on the ANSI keyboard model will make the keyboard and touchpad inaccessible until step 2 is ran, so an external keyboard must be connected to complete the update on this model!}}

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 ansi
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 ansi
sudo poweroff # do not use 'reboot'
</pre>

When done, if some of the keys produce incorrect characters, please check your OS’s language settings. For ANSI users, the default OS may have shipped with English UK as the default language; you can change it to English US if desired.

==== Revised Firmware ====

In addition, you might consider using revised firmware data; this is one final step that should not require a reboot:

Step 3: '''ISO''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_iso.hex
</pre>

Step 3: '''ANSI''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_ansi.hex
</pre>

=== X-Windows Configuration ===
''Before making adjustments, consider updating the firmware; reset your adjustments before updating the firmware, so that your adjustments do not interfere with new functionality.''

Some forum members have found that an adjustment to X-Windows will allow finer motion in the touchpad. If you use the '''Synaptic''' mouse/touchpad driver, use this command to make the change live:
<pre>synclient MinSpeed=0.25</pre>
You may experiment with different settings, but 0.25 was tested as helping noticeably. 
 
To make the change persist across reboots, change the file <code>/etc/X11/xorg.conf</code> similar to below:
<pre> Section "InputClass"
Identifier "touchpad catchall"
Driver "synaptics"
MatchIsTouchpad "on"
MatchDevicePath "/dev/input/event*"
Option "MinSpeed" "0.25"
EndSection</pre>
The line <code>Option "MinSpeed" "0.25"</code> is the change. 
 
Another forum user built on the above settings a little, and have found these to be very good:
<pre>synclient MinSpeed=0.25
synclient TapButton1=1
synclient TapButton2=3
synclient TapButton3=2
synclient FingerLow=30
synclient PalmDetect=1
synclient VertScrollDelta=64
synclient HorizScrollDelta=64</pre>

<code>FingerLow</code> has the same value as 'FingerHigh' in one config (30). It is believed to help reduce mouse movement as you lift your finger, but it's unknown whether synaptic works like this.
You may find this config to be comfortable for daily use.
 

<code>TabButton</code> allows to just tab the touchpad instead of physically pressing it down (to get this click noise).

The <code>right mouse click</code> is emulated by tapping with two fingers on the touchpad. If you feel that this is not very responsive you can try this value:
<pre> synclient MaxTapTime=250 </pre>

Some users may encounter an issue with the mouse jumping when typing when using libinput driver (has not been test with synaptic) due to their hand hitting the touchpad which can be fixed by updating the xorg settings to disable it while typing. One can disable the touchpad while typing by setting the below option in the xorg config simliar to the previou example.

<pre>
Option "DisableWhileTyping" "on"
</pre>

The setting can be verified by using the xinput command to first list the devices and then listing the properties for the Touchpad device. Exact commands to check this have been omitted for save of brevity. If DisableWhileTyping is shown enabled but does not appear to be working the issue may be due to the fact that the keyboard is connected to a USB bus which causes it to be seen as a external keyboard. To resolve this one can add the config below which sets the keyboard to internal to ensure the DisableWhileTyping works properly.

You will need to edit <code>/etc/libinput/local-overrides.quirks</code> and add the following lines:
<pre>
[Serial Keyboards]
MatchUdevType=keyboard
MatchBus=usb
AttrKeyboardIntegration=internal
</pre>

Once X11 is restarted the new setting should now take effect and you will no longer be able to use the touchpad while typing which will mostly eliminate the mouse jumping issue.

== Power Supply ==
* Input Power: 5V DC @ 3A
* Mechanical: 3.5mm OD / 1.35mm ID, Barrel jack
* USB-C 5V, 15W PD quickcharge
* Only use one power input at a time, barrel jack OR USB-C

== LEDs ==
In total, there are four LEDs on the Pinebook Pro, three of which are placed in the top-left side of the keyboard, and one near the barrel port:

# The red LED next to the barrel port indicates charging, in three ways. First, it will illuminate steadily when either the factory power supply or a USB Type-C charger is connected to the Pinebook Pro, and the battery is getting charged. Second, if the battery is at 100%, the LED will remain turned off regardless of the connected power input; however, this is [https://forum.pine64.org/showthread.php?tid=10899 rather rarely achieved]. Third, this LED will flash at 0.5 Hz if there are any problems that prevent charging, such as the battery becoming too hot.
# The power indicator LED, above the keyboard, supports three different colors: green, amber and red. It is also capable of flashing to indicate eMMC activity. In the default Debian with MATE build, green LED means power and red means suspend (amber is unused).
# The green NumLock LED, above the keyboard.
# The green CapsLock LED, above the keyboard.

The NumLock and CapsLock LEDs serve their usual purposes on a keyboard, but they also have a secondary function. When the privacy switches get activated they blink to confirm that the switch has been activated.

== Webcam ==
{{Hint| You can use Cheese to test the Camera functionality}}
* Streaming video resolutions supported, (uncompressed):
** 320 x 240
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Still frame resolutions supported:
** 160 x 120
** 176 x 144
** 320 x 240
** 352 x 288
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200

== Microphones ==
While it has been said that some Pinebook Pro units contain only one microphone despite having two labeled microphone holes on the outer casing, other units do indeed contain two microphones. It is presently unclear which batches have either configuration; units from the initial community batch of 1000 units (following the initial 100) are believed to contain two, populating both labeled holes.

The wires leading to both microphones connect to the mainboard with a small white plastic connector, located directly adjacent to the ribbon cable attachment point for the keyboard interface.

'''Microphones not working?'''

If pavucontrol input doesn't show microphone activity try changing the [[Pinebook_Pro#Privacy_Switches|privacy switches]]. If the switches are in the correct place and microphone input isn't working you can run <code>alsamixer</code> from the command line, hit F6 and select the es8316, hit F4 to get to the capture screen, select the bar labeled ADC, increase the gain to 0dB, change the audio profile in pavucontrol to another one with input. Additionally you may want to modify ADC PGA to get the levels to where you want them. If that still hasn't fixed it you may want to check that the microphone connector is plugged in (see the section [[#Technical Reference|Technical Reference]]).

== Bluetooth and WiFi ==
[[File:PinebookPro_WirelessIC_Location.jpg|400px|thumb|right|The Pinebook Pro's AP6256 wireless module]]
===Hardware Overview===
The Pinebook Pro contains an AMPAK AP6256 wireless module to provide Wi-Fi (compliant to IEEE 802.11ac) and Bluetooth (compliant to Bluetooth SIG revision 5.0). The module contains a Broadcom transceiver IC, believed to be the BCM43456, as well as the support electronics needed to allow the Wi-Fi and Bluetooth modes to share a single antenna.

The wireless module interfaces with the Pinebook Pro’s system-on-chip using a combination of three interfaces: Bluetooth functionality is operated by serial UART and PCM, while the Wi-Fi component uses SDIO. It is unknown if the module’s Bluetooth capabilities are usable under operating systems that do not support SDIO.

The module’s RF antenna pin is exposed on the mainboard via a standard Hirose U.FL connector, where a coaxial feedline links it to a flexible adhesive antenna situated near the upper right corner of the Pinebook Pro’s battery. As the RF connector is fragile and easily damaged, it should be handled carefully during connection and disconnection, and should not be reconnected frequently.

===Issues===
Problems have been reported with the Wi-Fi transceiver’s reliability during extended periods of high throughput, especially on the 2.4 GHz band. While the cause of this has yet to be determined, switching to the 5 GHz band may improve stability.

Since the Bluetooth transceiver shares both its spectrum and antenna with 2.4 GHz Wi-Fi, simultaneous use of these modes may cause interference, especially when listening to audio over Bluetooth. If Bluetooth audio cuts out frequently, switching to the 5 GHz band – or deactivating Wi-Fi – may help.

===Wi-Fi Capabilities===
Wi-Fi on the Pinebook Pro is capable of reaching a maximum data transfer rate of approximately 433 megabits per second, using one spatial stream. The transceiver does not support multiple spatial streams or 160-MHz channel bandwidths.

The Wi-Fi transceiver supports the lower thirteen standard channels on the 2.4 GHz band, using a bandwidth of 20 MHz. At least twenty-four channels are supported on the 5 GHz band, spanning frequencies from 5180 to 5320 MHz, 5500 to 5720 MHz, and 5745 to 5825 MHz, with bandwidths of 20, 40, or 80 MHz.

Maximum reception sensitivity for both bands is approximately -92 dBm. The receiver can tolerate input intensities of no more than -20 dBm on the 2.4 GHz band, and no more than -30 dBm on the 5 GHz band. Maximum transmission power is approximately +15 dBm for either band, falling further to approximately +10 dBm at higher data transfer rates on the 5 GHz band.

With current available drivers and firmware, the Wi-Fi interface supports infrastructure, ad-hoc, and access-point modes with satisfactory reliability. Monitor mode is not presently supported. Wi-Fi Direct features may be available, but it is unclear how to make use of them under Linux.

Be aware that Linux userspace utilities, such as <code>iw</code>, may report inaccurate information about the capabilities of wireless devices. Parameter values derived from vendor datasheets, or direct testing, should be preferred to the outputs of hardware-querying tools.

===Bluetooth Capabilities===
Bluetooth data transfer speeds have an indicated maximum of 3 megabits per second, but it is unclear what practical data rates can be expected. Audio streaming over Bluetooth is functioning normally, as is networking. Bluetooth Low-Energy functions, such as interacting with Bluetooth beacons, have not yet been tested conclusively.

The Bluetooth transceiver supports all 79 channel allocations, spanning frequencies from 2402 MHz to 2480 MHz. Reception sensitivity is approximately -85 dBm, with a maximum tolerable reception intensity of -20 dBm. Bluetooth transmission power is limited to +10 dBm.

===Disabling Bluetooth===

To disable Bluetooth under Linux once:

sudo rfkill block bluetooth

To confirm if Bluetooth under Linux is disabled:

rfkill

To disable Bluetooth on boot (note: for distributions such as Manjaro XFCE see the step below):

sudo systemctl enable rfkill-block@bluetooth

To disable Bluetooth on certain distributions, such as Manjaro XFCE, right click on the Bluetooth panel icon, select plugins, then PowerManager, then configuration and then deselect the auto power on option

== LCD Panel ==
* Model: BOE NV140FHM-N49
* 14.0" (35.56 cm) diagonal size
* 1920x1080 resolution
* 60 Hz refresh rate
* IPS technology
* 1000:1 contrast
* 250 nit brightness
* 63% sRGB coverage
* 6-bit color
* 30-pin eDP connection

Some people have tested hardware video decode using the following;

<pre>ffmpeg -benchmark -c:v h264_rkmpp -i file.mp4 -f null -</pre>

== External ports list ==
Here are a list of the external ports. See [[Pinebook_Pro#Expansion_Ports|Technical Reference - Expansion Ports]] for port specifications.
* Left side
** Barrel jack for power, (with LED)
** USB 3, Type A
** USB 3, Type C
* Right side
** USB 2, Type A
** Standard headset jack
** MicroSD card slot

== Using the UART ==
[[File:PinePhone_Serial_Cable.png|400px|thumb|right|Pinout of the serial adapter. Swapping the tx and rx around from this also works and is more traditional. See the official [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pine64 document].]]

UART output is enabled by flipping the UART switch to the ON position (item 9). To do so you need to remove the Pinebook Pro's bottom cover - please follow [[Pinebook_Pro#Disassembly_and_Reassembly|proper disassembly and reassembly protocol]]. The OFF position is towards the touchpad, the ON position is towards the display hinges.

With the UART switch in the ON position, console is relayed via the audiojack and the laptop's sound is turned OFF. Please ensure that you are using a 3.3 V interface (such as the CH340, FTDI-232R, or PL2303, which are sold in both 3.3 V and 5 V variants) to avoid damage to the CPU. Older version of the serial console cable sold by Pine64 uses wrong voltage level and should not be used; see [https://forum.pine64.org/showthread.php?tid=9367 this forum thread] for further information. Recent version of the same cable uses the right voltage level.

Insert the USB plug of the cable into an open USB port on the machine which will monitor, ensuring that the audio jack of the serial cable is be fully inserted into the Pinebook Pro audio port. Run the following in a terminal:

<code>
$ lsusb
</code>

you should find a line similar to this:

<code>
Bus 001 Device 058: ID 1a86:7523 QinHeng Electronics HL-340 USB-Serial adapter
</code>

Serial output should now be accessible using screen, picocom or minicom (and others).
Examples:

<code>
screen /dev/ttyUSB0 1500000

picocom /dev/ttyUSB0 -b 1500000

minicom -D /dev/ttyUSB0 -b 1500000</code>

Old versions of U-Boot do not use the UART for console output. <strike>The console function is activated by the Linux kernel. Thus, if you use a non-Pinebook Pro Linux distro and want the UART as a console, you have to manually enable it.</strike>

== Using the optional NVMe adapter ==
The optional NVMe adapter allows the use of M.2 cards that support the NVMe standard, (but not SATA standard). The optional NVMe M.2 adapter supports '''M''' & '''M'''+'''B''' keyed devices, in both 2242 & 2280 physical sizes, the most common ones available. In addition, 2230 & 2260 are also supported, though NVMe devices that use those sizes are rare.

Once you have fitted and tested your NVMe drive, please add a note to this page [[Pinebook Pro Hardware Accessory Compatibility]] to help build a list of tried and tested devices.

Please see [[Pinebook Pro Troubleshooting Guide#NVMe SSD issues|a separate section]] that describes reported issues with the NVMe drives in PineBook Pro.

=== Installing the adapter ===
The V2.1-2019-0809 SSD adapter that shipped with the initial Pinebook Pro batches had significant issues. A repair kit will be shipped to address those issues.
(If necessary, it can be modified to work. There is [https://forum.pine64.org/showthread.php?tid=8322&pid=52700#pid52700 an unofficial tutorial on the forums] describing these modifications.)

The updated SSD adapter, labeled V2-2019-1107, takes into account the prior problems with touchpad interference. New orders as of Feb. 22nd, 2020 will be the updated adapter.

This is the link to the Pinebook Pro accessories in the store: [[https://pine64.com/?v=0446c16e2e66]]

Actual installation instructions are a work in progress. Unofficial instructions for installing V2-2019-1107 can be found [https://eli.gladman.cc/blog/2020/06/23/pine-book-pro-nvme.html here].

=== Post NVMe install power limiting ===
Some NVMe SSDs allow reducing the maximum amount of power. Doing so may reduce the speed, but it may be needed in the Pinebook Pro to both improve reliability at lower battery levels. And to reduce power used, to maintain battery life.
Here are the commands to obtain and change the power settings. The package 'nvme-cli' is required to run these commands. The example shows how to find the available power states, and then sets it to the lowest, non-standby setting, (which is 3.8 watts for the device shown);

<pre>$ sudo nvme id-ctrl /dev/nvme0
NVME Identify Controller:
...
ps 0 : mp:9.00W operational enlat:0 exlat:0 rrt:0 rrl:0
rwt:0 rwl:0 idle_power:- active_power:-
ps 1 : mp:4.60W operational enlat:0 exlat:0 rrt:1 rrl:1
rwt:1 rwl:1 idle_power:- active_power:-
ps 2 : mp:3.80W operational enlat:0 exlat:0 rrt:2 rrl:2
rwt:2 rwl:2 idle_power:- active_power:-
ps 3 : mp:0.0450W non-operational enlat:2000 exlat:2000 rrt:3 rrl:3
rwt:3 rwl:3 idle_power:- active_power:-
ps 4 : mp:0.0040W non-operational enlat:6000 exlat:8000 rrt:4 rrl:4
rwt:4 rwl:4 idle_power:- active_power:-

$ sudo nvme get-feature /dev/nvme0 -f 2
get-feature:0x2 (Power Management), Current value:00000000
$ sudo nvme set-feature /dev/nvme0 -f 2 -v 2 -s
set-feature:02 (Power Management), value:0x000002</pre>
Some NVMe SSDs don't appear to allow saving the setting with "-s" option. In those cases, leave off the "-s" and use a startup script to set the non-default power state at boot. 
If you want to test performance without saving the new power setting semi-permanantly, then leave off the "-s" option. 
 
There is another power saving feature for NVMes, APST, (Autonomous Power State Transitions). This performs the power saving & transitions based on usage. To check if you have a NVMe SSD with this feature;
<pre>$ sudo nvme get-feature -f 0x0c -H /dev/nvme0</pre>
Information for this feature, (on a Pinebook Pro), is a work in progress.

=== Using as data drive ===
As long as the kernel in use has both the PCIe and NVMe drivers, you should be able to use a NVMe drive as a data drive. It can automatically mount when booting from either the eMMC or an SD card. This applies to Linux, FreeBSD, and Chromium, using the normal partitioning and file system creation tools. Android requires testing.

=== Using as OS root drive ===
The SoC does not include the NVMe boot code, so the NVMe is not in the SoC's boot order. However, using the [https://github.com/mrfixit2001/updates_repo/blob/v1.1/pinebook/filesystem/mrfixit_update.sh U-Boot update script] from the mrfixit2001 Debian or [https://pastebin.com/raw/EeK074XB Arglebargle's modified script], and [https://github.com/pcm720/rockchip-u-boot/releases the modified u-boot images] provided by forum user pcm720, you can now add support to boot from an NVMe drive. Binary images are useable with SD, eMMC, and [[Pinebook_Pro_SPI|SPI flash]]. For OS images using the mainline kernel, there are a few variants of U-Boot available that also support NVMe as the OS drive. Though these may require writing the U-Boot to the SPI flash for proper use of the NVMe as the OS drive.

The current boot order, per last testing, for this modified U-Boot is:
*MicroSD
*eMMC
*NVMe

For more information, please refer to [https://forum.pine64.org/showthread.php?tid=8439&pid=53764#pid53764 the forum post.]

It is also possible to initially boot off an eMMC or SD card, then transfer to a root file system on the NVMe. Currently, it is necessary to have the U-Boot code on an eMMC or SD card. (A forum member [https://forum.pine64.org/showthread.php?tid=8439 posted here] about using a modified version of U-Boot with NVMe drivers, that uses <code>/boot</code> and <code>/</code> off the NVMe drive. So this may change in the future.)

Please see [[Pinebook_Pro#Bootable Storage|Bootable Storage]].

== Caring for the PineBook Pro ==
=== Bypass Cables ===
The mainboard features two (disconnected by default) bypass cables that are only to be used with the battery disconnected. The female (10) male (6) ends of the bypass cables can be connected to provide power to the mainboard if you need to run the laptop without a battery. Please refer to this [https://files.pine64.org/doc/PinebookPro/PinebookPro_Engineering_Notice.pdf engineering notice].

'''Note that despite the bypass cable being a two conductor cable, it is only used as one. Both wires being soldered together on either side is normal!'''

{{warning|Do not connect the bypass cables with the battery connected. Using the bypass cables with the battery connected can permanently damage the computer.}}

=== Pinebook Service Step-by-Step Guides ===

Under [[Pinebook_Service_Step_by_Step_Guides|Service Guides for Pinebook]] you can find instructions guides concerning disassembly of:

* The installation process on Pinebook Pro similar to 14" Pinebook
* The installation process is the reverse order of removal guide:
** 14″ Pinebook Lithium Battery Pack Removal Guide
** 14″ Pinebook LCD Panel Screen Removal Guide
** 14″ Pinebook eMMC Module Removal Guide

== Using the SPI flash device ==

See [[Pinebook Pro SPI]] for details.

The Pinebook Pro comes with a 128Mbit, (16MByte), flash device suitable for initial boot target, to store the bootloader. The SoC used on the Pinebook Pro boots from this SPI flash device first, before eMMC or SD card. At present, April 19, 2020, the Pinebook Pros ship without anything programmed in the SPI flash device. So the SoC moves on to the next potential boot device, the eMMC. ARM/ARM64 computers do not have a standardized BIOS, yet.

Here is some information on using the SPI flash device:

* You need the kernel built with SPI flash device support, which will supply a device similar to: code>/dev/mtd0</code>
* The Linux package below, will need to be available: <code>mtd-utils</code>
* You can then use this program from the package to write the SPI device: <code>flashcp <filename> /dev/mtd0</code>

Even if you need to recover from a defective bootloader written to the SPI flash, you can simply short pin 6 of the SPI flash to GND and boot. This will render the SoC bootrom unable to read from the SPI flash and have it fall back to reading the bootloader from other boot media like the eMMC or Micro SD card.

The procedures described above are a lot less risky than attaching an external SPI flasher and do not require any additional hardware. At present, April 19th, 2020, there is no good bootloader image to flash into the SPI flash device. This is expected to change, as there are people working on issue.

= Software tuning guide =
Details on how to get the most out of a Pinebook Pro & its RK3399 SoC.

== Customizing the Pinebook Pro's default Manjaro KDE system ==
=== Watching DRM content (Netflix, etc.) ===
Most paid online streaming services use Widevine DRM to make their content more difficult to pirate. Widevine is not directly supported on Manjaro KDE, however it is still possible to watch DRM content via the "chromium-docker" package which downloads a 32-bit ARM container and installs Chromium with Widevine inside of that. While not space-efficient, or efficient in general, it's the recommended solution for watching this content on your Pinebook Pro. You can install this package with:
<pre>sudo pacman -Sy chromium-docker</pre>

=== Checking GPU capabilities ===
To see what versions of OpenGL and OpenGL ES are supported by the Pinebook Pro, what driver is in use, and what version of the driver is loaded, install the "mesa-demos" package with:
<pre>sudo pacman -Sy mesa-demos</pre>
And then run:
<pre>glxinfo | grep OpenGL</pre>
This will give detailed information about your graphics card and driver, useful for debugging.

=== Better GPU compatibility and performance ===
For better graphics performance, you may install the "mesa-git" package, built and supplied in the Manjaro ARM repos. This lets you bring in the latest features, optimizations, and bugfixes for the graphics driver used by the Pinebook Pro. Installation is as simple as:
<pre>pacman -Sy mesa-git</pre>
Then you may reboot to load the newer driver.

With Mesa 20.2 there is no longer much reason to use this over the standard mesa package, and applications may occasionally break with mesa-git.

[https://docs.mesa3d.org/bugs.html Reporting bugs] to the Mesa project will help make sure any problems are quickly fixed.

=== OpenGL 3.3 support ===
By default, with the current state of the Panfrost GPU driver, the Pinebook Pro supports OpenGL 2.1 and OpenGL ES 3.0. If you want to use OpenGL 3.3, you need to set the system-wide environment variable, open the '''/etc/environment''' file with:
<pre>kate /etc/environment</pre>
And then at the bottom of the file, on a new line, add:
<pre>PAN_MESA_DEBUG="gl3"</pre>
Then save the file, entering your password when prompted, and reboot the system. When you check your GPU capabilities, it should report OpenGL 3.3 and applications that rely on it should function properly. Note that GL 3.3 support is incomplete and some rendering features do not work yet, notably geometry shaders.

=== Install Anbox on Pinebook Pro Manjaro 20.10 ===
[https://www.youtube.com/watch?v=EU8_Q11dATs Youtube video on installing Anbox on Pienbook Pro Manjaro Build 20.10 by LivingLinux]

== Customizing the Pinebook Pro's previously-default Debian system ==
Here are some hints on what you can do to customize the Pinebook Pro's previous factory image (aka [https://github.com/mrfixit2001/debian_desktop mrfixit2001 debian build])

=== Initial user changes, password, name, etc ===
When you first get your Pinebook Pro, you should consider setting strong passwords and making the default account your own.

* Reboot (this is just to ensure all background processes belong to the user are not running... there are other ways to achieve this but this way is easy)
* Once the machine reboots press Alt-Ctrl-F1 to bring up a text terminal
* Login as root (login: root, password: root)
* Set a strong password for the root user using the following command and it's prompts:
<pre># passwd (and follow prompts)</pre>
* Rename the rock user to your prefered username (replace myself with whatever you like):
<pre># usermod -l myself -d /home/myself -m rock</pre>
* Rename the rock group to match your preferred username:
<pre># groupmod -n myself rock</pre>
* Put your name in the account, (replace "John A Doe" with your name):
<pre># chfn -f "John A Doe" myself</pre>
* Set a strong password for the normal user:
<pre># passwd myself</pre>
* Log out of the text terminal:
<pre># logout</pre>
* Press Alt-Ctrl-F7 to go back to the login screen and then login as the normal user
* Open text terminal to fix login error: "Configured directory for incoming files does not exist";
<pre>$ blueman-services</pre>
Select "Transfer" tab and set "Incoming Folder" to myself
OR
If adduser is in distro, this is MUCH easier
sudo adduser $USER ,, fill out requested data
Then,, sudo adduser $USER $GROUP,,, 1 group at a time
To see which groups to add,,, id $USER, id rock

=== Changing the default hostname ===
Debian 9 has a command to allow you to change the hostname. You can see the current settings using;
<pre>$ sudo hostnamectl
Static hostname: Debian-Desktop
Icon name: computer
Machine ID: dccbddccbdccbdccbdccbdccbdccbccb
Boot ID: ea99ea99ea99ea99ea99ea99ea99ea99
Operating System: Debian GNU/Linux 9 (stretch)
Kernel: Linux 4.4.210
Architecture: arm64</pre>
To change, use this, (with "My_Hostname" used as the example);
<pre>$ sudo hostnamectl set-hostname My_Hostname</pre>
Whence done, you can re-verify using the first example.

Then you should backup and edit your <code>/etc/hosts</code> entry's name;
<pre>$ sudo cp -p /etc/hosts /etc/hosts.`date +%Y%m%d`
$ sudo vi /etc/hosts
127.0.0.1 localhost
127.0.0.1 My_Hostname
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
127.0.1.1 linaro-alip</pre>

=== Disable Chromium browser's prompt for passphrase & password storage ===

Perform the following steps:

* On the tool bar, hover over the Chromium icon
* Using the right mouse button, select '''Properties'''
* In the '''Command:''' line section, add <code>--password-store=basic</code> before the <code>%U</code>
* Use the '''x Close''' button to save the change
This will of course, use basic password storage, meaning any saved passwords are not encrypted. Perfectly fine if you never use password storage.

=== Changing the boot splash picture ===

The default boot splash picture can be replaced using the following instructions:

* Install '''ImageMagick''' which will do the conversion
<pre>$ sudo apt-get install imagemagick</pre>
* Create a 1920 x 1080 picture. For the best results, use a PNG image (It supports lossless compression).
* From the directory in which your new image is stored run the following commands
* Convert your image to the bootsplash raw format using imagemagick convert.
<pre>$ convert yoursplashimage.png -separate +channel -swap 0,2 -combine -colorspace sRGB RGBO:splash.fb</pre>
* Create a backup copy of your current splash screen
<pre>$ sudo cp /usr/share/backgrounds/splash.fb /usr/share/backgrounds/splash_original.fb</pre>
* Copy your new splash screen into place
<pre>$ sudo cp splash.fb /usr/share/backgrounds/splash.fb</pre>
* Set the correct permissions on the splash.fb file
<pre>$ sudo chmod 644 /usr/share/backgrounds/splash.fb</pre>
* If you do not want to see kernel console text messages, make sure you don't have '''Plymouth''' installed

=== Watching Amazon Prime videos with Chromium ===
When you create a new user, it will be necessary to launch the Chromium browswer with a specific user agent like below;
<pre>chromium-browser --user-agent="Mozilla/5.0 (X11; CrOS armv7l 6946.63.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36"</pre>
There may be more tweaks needed.

=== Enabling text boot time messages ===

By default, most Linux distros have a boot screen with a picture. To see all the boot time messages, use one of the following;

==== Debian ====
* Backup and edit the U-Boot configuration file:

cp -p /etc/default/u-boot /etc/default/u-boot.`date +%Y%m%d`
chmod a-w /etc/default/u-boot.`date +%Y%m%d`
vi /etc/default/u-boot

Remove the '''quiet''' and '''splash''' parameters. Leave everything else alone.

* Update the U-Boot configuration:

u-boot-update

* Test and verify you get what you think you should be seeing.

==== Manjaro ====
* Backup and edit the U-Boot configuration file:

cp -p /boot/extlinux/extlinux.conf /boot/extlinux/extlinux.conf.`date +%Y%m%d`
chmod a-w /boot/extlinux/extlinux.conf.`date +%Y%m%d`
vi /boot/extlinux/extlinux.conf

* Change '''console=ttyS2,1500000''' to '''console=tty1'''
* Remove the '''bootsplash.bootfile''' option and it's parameter.
* You can add verbose logging by appending '''ignore_loglevel''' to the line where boot splash was.
* Leave everything else alone.
* Test and verify you get what you think you should be seeing.

== Improving readability ==

Some people find that a 14" LCD screen with 1080p, (1920 x 1080), has text and icons a bit too small. There are things you can do to make the screen easier to use and read. 
* Increase the font size
* Use a font with more pronounced features
* Increase the various window manager sizes (e.g. increase the height of the tool bar)
* Change the color scheme to be easier on the eyes. Higher contrast can help usability.
* Change the window manager's decorations (e.g. use larger icons)
* Use a workspace manager, with one application per workspace
* When at home or office, use an external monitor
* Change the X-Windows DPI. One such method that someone used successfully, is: <blockquote><code>echo "Xft.dpi: 150" >> ~/.Xresources</code></blockquote>Change the 150 as desired to get the size adjustment you want.
 
However, do not change the resolution of the LCD screen, otherwise you may end up with a blank / black screen. If that happens, see this troubleshooting section for the fix: 
[[Pinebook_Pro#After_changing_builtin_LCD_resolution.2C_blank_screen|Blank screen after changing builtin LCD resolution]]

== Chromium tweaks ==

=== Flags ===

From the [https://github.com/mrfixit2001/updates_repo/blob/v1.8/pinebook/filesystem/default official Debian image]:

<pre>
--disable-low-res-tiling \
--num-raster-threads=6 \
--profiler-timing=0 \
--disable-composited-antialiasing \
--test-type \
--show-component-extension-options \
--ignore-gpu-blacklist \
--use-gl=egl \
--ppapi-flash-path=/usr/lib/chromium-browser/pepper/libpepflashplayer.so \
--ppapi-flash-version=32.0.0.255 \
--enable-pinch \
--flag-switches-begin \
--enable-gpu-rasterization \
--enable-oop-rasterization \
--flag-switches-end
</pre>

Note that in some cases, this may also decrease performance substantially, as observed when using these flags on the Manjaro KDE desktop. Feel free to experiment to find what is smoothest for you personally.

== gVim has performance issue ==
It appears that using GTK3 can cause very slow scrolling, while Vim in a terminal window works fine. 
Simply revert back to using GTK2, (how to do so is somewhat Linux distro-specific).

Another solution may be to run gVim with

GDK_RENDERING=image

environment variable set. It seems that this improves the performance by reverting back to software-only rendering.

== Kernel options ==
Here are some Pinebook Pro & its RK3399 SoC Linux specific options. If kernel version, (or version range specific), it should list that information in the description.

To see if a specific feature is enabled in the current kernel, you can use something like this;

<pre>
$ zgrep -i rockchip_pcie /proc/config.gz
# CONFIG_ROCKCHIP_PCIE_DMA_OBJ is not set
CONFIG_PHY_ROCKCHIP_PCIE=m
</pre>
If it's listed as <code>=m</code>, then it's a module. You can see if the module is loaded with;
<pre>
$ lsmod | grep -i rockchip_pcie
phy_rockchip_pcie 16384 0
</pre>
Note modules are not loaded until needed. Thus, we sometimes check the kernel configuration instead to see if a feature is configured first, then see if it's a module.

=== Hardware video decoding ===
Here is a method to check for hardware video decoding by the VPU. There are special Linux kernel modules that perform this function. 
Older systems, such as the previously-default Debian desktop, use the Rockchip-supplied kernel module <code>rk-vcodec</code>. To check, something like this can be used:
<pre>
$ lsmod | grep rk-vcodec
or
$ zgrep RK_VCODEC /proc/config.gz
CONFIG_RK_VCODEC=y
</pre>
Note that in the above example, the Rockchip video CODEC is not built as a module, but included into the kernel. Thus, it does not show up in the list modules check. 
 

Newer systems may use a different option as in the configuration below:
<pre>
$ zgrep HANTRO /proc/config.gz
CONFIG_VIDEO_HANTRO=m
CONFIG_VIDEO_HANTRO_ROCKCHIP=y
</pre>

= Troubleshooting guide =

Do not to panic if something goes wrong or in an unexpected way. Instead, stop and consider carefully how to undo something, or how to redo it. This particularly applies when flashing a new operating system, or flashing new firmware to the keyboard or touchpad. If everything fails, consider reporting the issue on the forums, with as many relevant details as available.

Please, have a look at the [[Pinebook Pro Troubleshooting Guide]], which details a number of issues you may encounter.

= Hardware/Accessory Compatibility =
Please contribute to the [[Pinebook Pro Hardware Accessory Compatibility|hardware/accessory compatibility page]], which lists the status of hardware tested with the Pinebook Pro. Available hardware categories include the following:

* [[Pinebook Pro Hardware Accessory Compatibility#NVMe SSD drives|NVMe SSD drives]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB hardware|USB hardware]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB C alternate mode DP|USB-C alternate mode DP]]
* [[Pinebook Pro Hardware Accessory Compatibility#Other hardware|Other hardware]]

= Technical Reference =
== Disassembly and Reassembly ==
[[File:Standoffs.png|400px|thumb|right|Pinebook Screw stand-offs correct placement and location]]

[[File:Hinges_cover_removed_1.jpeg|300px|thumb|right|Hinge area of the Pinebook Pro lid with the cover removed]]
[[File:Hinges_cover_removed_2.jpeg|300px|thumb|right|Close-up of a Pinebook Pro lid hinge]]

There are a few '''mandatory''' precautions to be taken:

* Do not open the laptop by lifting the lid while the Pinebook Pro bottom cover is removed - this can cause structural damage to the hinges and/or other plastic components of the chassis such as the IO port cut-outs.
* When removing the back cover plate, *do not, under any circumstances, slide your fingertips between the metal shell and the plastic frame!* The back cover plate edges are sharp, and when combined with the pressure and movement generated from, specifically, attempting to slide the tips of your fingers along the bottom edge of the plate along the lid-hinge, they *will* slice open the tips of your fingers like a knife.
* When removing the back cover plate, use care to avoid damaging the speakers. They can be stuck to the back cover with double-sided tape, and the thin wires are very delicate. Newer Pinebook Pro laptops (as of the May 2021 batch, and perhaps earlier) seem to lack the double-sided tape to the rear cover, instead opting for tape or glue that makes them stick to the front cover. Nevertheless, be gentle when removing the back cover.

[[File:PinebookProScrewGuide.png|400px|thumb|right|Pinebook Pro external screws (this particular unit has suffered damage on screw (4)L)]]

When disassembling the laptop make sure that it is powered off and folded closed. To remove the bottom cover of the Pinebook Pro, first remove the ten (10) Phillips head screws that hold the bottom section of the laptop in place. There are four (4) short screws along the front edge, and six (6) long screws along the 3 remaining sides. Remove the cover from the back where the hinges are situated by lifting it up and away from the rest of the chassis. The aluminum case is held on only by screws. There are no plastic snaps, and the shell should pull away without any effort. If you experience any resistance at all stop and ensure all ten (10) screws are accounted for.

During reassembly, make sure that the back-screw standoffs are in place and seated correctly. Before replacing the aluminum back-plate, ensure that the speakers are properly seated by pressing gently on the hard plastic edge of the speaker module. Slide the bottom section into place so it meets the front lip of the keyboard section. Secure the front section (where the touchpad is located) in place using the short screws in the front left and right corners. Then proceed to pop in the bottom panel into place. Secure the bottom section (where hinges are located) by screwing in the left and right corners. Then screw in the remaining screws and run your finger though the rim on the chassis to make sure its fitted correctly. Note that the front uses the remaining 4 short screws.

The screws are small and should only be finger tight. Too much force will strip the threads. If after installing screws the back cover plate has not seated properly on one side (which may be caused by the aforementioned misseating of the speakers), open the display and hold the base on either side of the keyboard and gently flex the base with both hands in opposing directions. Once the side pops further in, then recheck the screws on that side. If it does not pop back in, re-open the machine and check for misseated components.

A basic 3D model to print replacement standoffs for the back cover screws is [https://www.thingiverse.com/thing:4226648 available on Thingiverse], until the official drawings or 3D models are made available.

====Display Disassembly====
It is not recommended to adjust the position of the lid when the bottom cover is removed, because the bottom cover provides structural strength, so the lid should be open fully as the first step, before starting any disassembly of the laptop. After opening the lid, remove the bottom cover by following the instruction found in the section above. Alternatively, you can keep the lid closed and remove the screws that hold the hinges to the main laptop body, as described in [[Pinebook Service Step by Step Guides]].

Parts of the hinge mechanism, as well as the screws that hold the hinges to the lid, are hidden behind an elongated plactic U-shaped cover that snaps in place using latches. Use a dedicated plastic prying tool or a guitar pick to gently pry the cover and remove it, starting from the outer edge. Once you pry the cover to a certain extent, it should be possible to remove it fully using only your hands. The U-shaped cover is rather sturdy, but still be careful not to break or bend it.

There are two small screws hidden underneath the two small rubber nubs on the upper part of the screen bezel, so first gently remove the nubs and then remove the screws. The screen bezel is held in place with a combination of latches and some adhesive tape, which is there to prevent dust ingress. The adhesive isn't very strong, and the bezel is capable of flexing back into shape after being twisted to a certain extent. There is more adhesive on the bottom part of the screen bezel, so be more careful while prying that section apart. Use the same prying tool that you used for the U-shaped cover, and work it around the outer edges of the screen bezel.

== Internal Layout ==

=== Main chips ===
* RK3399 system-on-chip (1)
* LPDDR4 SDRAM (21)
* SPI NOR flash memory (29)
* eMMC flash memory (26)
* WiFi/BT module (27)

=== Mainboard Switches and Buttons ===
There are two switches on the main board: disabling the eMMC (24), and enabling UART (9) via headphone jack.

The Reset and Recovery buttons (28): the reset button performs an immediate reset of the laptop. The Recovery button is used to place the device in maskrom mode; this mode allows flashing eMMC using Rockchip tools (e.g. rkflashtools).

[[File:PBPL_S.jpg]]

=== Key Internal Parts ===
{| class="wikitable"
|+ Numbered parts classification and description
! Number
! Type
! Descriptor
|-
! scope=row | 1
| Component || RK3399 System-On-Chip
|-
! scope=row | 2
| Socket || PCIe x4 slot for optional NVMe adapter
|-
! scope=row | 3
| Socket || Speakers socket
|-
! scope=row | 4
| Socket || Touchpad socket
|-
! scope=row | 5
| Component || Left speaker
|-
! scope=row | 6
| Connector || Power bridge connector
|-
! scope=row | 7
| Socket || Keyboard Socket
|-
! scope=row | 8
| Component || Optional NVMe SSD adapter
|-
! scope=row | 9
| Switch || UART/Audio switch - outputs UART via headphone jack
|-
! scope=row | 10
| Socket || Power bridge socket
|-
! scope=row | 11
| Socket || Battery socket
|-
! scope=row | 12
| Component || Touchpad
|-
! scope=row | 13
| Component || Battery
|-
! scope=row | 14
| Component || Right speaker
|-
! scope=row | 15
| Socket || MicroSD card slot
|-
! scope=row | 16
| Socket || Headphone / UART jack
|-
! scope=row | 17
| Socket || USB 2.0 Type A
|-
! scope=row | 18
| Socket || Daughterboard-to-mainboard ribbon cable socket
|-
! scope=row | 19
| Cable || Daughterboard-to-mainboard ribbon cable
|-
! scope=row | 20
| Component || microphone
|-
! scope=row | 21
| Component || LPDDR4 RAM
|-
! scope=row | 22
| Socket || Mainboard-to-daughterboard ribbon cable socket
|-
! scope=row | 23
| Socket || Microphone socket
|-
! scope=row | 24
| Switch || Switch to hardware disable eMMC
|-
! scope=row | 25
| Antenna || BT/WiFI antenna
|-
! scope=row | 26
| Component || eMMC flash memory module
|-
! scope=row | 27
| Component ||BT/WiFi module chip
|-
! scope=row | 28
| Buttons || Reset and recovery buttons
|-
! scope=row | 29
| Component || SPI flash storage
|-
! scope=row | 30
| Socket || eDP LCD socket
|-
! scope=row | 31
| Socket || Power in barrel socket
|-
! scope=row | 32
| Socket || USB 3.0 Type A
|-
! scope=row | 33
| Socket || USB 3.0 Type C
|}

=== Smallboard detailed picture ===

[[File:Pinebook_pro_smallboard.jpg]]

== Bootable Storage ==

=== Boot sequence details ===
The RK3399's mask 32KB ROM boot code looks for the next stage of code at byte off-set 32768, (sector 64 if using 512 byte sectors). This is where U-Boot code would reside on any media that is bootable. 
[[RK3399_boot_sequence|RK3399 boot sequence]]

=== Boot devices ===

The Pinebook Pro is capable of booting from eMMC, USB 2.0, USB 3.0, or an SD card. It cannot boot from USB-C. The boot order of the hard-coded ROM of its RK3399 SoC is: SPI NOR, eMMC, SD, USB OTG.

At this time, the Pinebook Pro ships with a Manjaro + KDE build with [https://www.denx.de/wiki/U-Boot/ u-boot] on the eMMC. Its boot order is: SD, USB, then eMMC.

(An update has been pushed for the older Debian + MATE build that improves compatibility with booting other OSes from an SD card. In order to update, fully charge the battery, establish an internet connection, click the update icon in the toolbar, and then reboot your Pinebook Pro. Please see [https://forum.pine64.org/showthread.php?tid=7830 this log] for details.)

Please note that PCIe, the interface used for NVMe SSD on the Pinebook Pro, is not bootable on the RK3399 and therefore is not a part of the boot hierarchy. It is possible to run the desired OS from NVMe by pointing extlinux on the eMMC to rootfs on the SSD. This requires uboot, the Kernel image, DTB, and extlinux.conf
in a /boot partition on the eMMC.

=== eMMC information ===
The eMMC appears to be hot-pluggable. This can be useful if trying to recover data or a broken install. Best practice is probably to turn the eMMC switch to off position before changing modules. Note that the enable/disable label on the silkscreen is incorrect on some board revisions (known bad on v2.1).

The eMMC storage will show up as multiple block devices:
*mmcblk1boot0 - eMMC standard boot0 partition, may be 4MB
*mmcblk1boot1 - eMMC standard boot1 partition, may be 4MB
*mmcblk1rpmb - eMMC standard secure data partition, may be 16MB
*mmcblk1 - This block contains the user areas

Only the last is usable as regular storage device in the Pinebook Pro.
The device number of "1" shown above may vary, depending on kernel.

If the eMMC module is enabled after boot from an SD card, you can detect this change with the following commands as user "root";
<pre>
echo fe330000.sdhci >/sys/bus/platform/drivers/sdhci-arasan/unbind
echo fe330000.sdhci >/sys/bus/platform/drivers/sdhci-arasan/bind
</pre>

== Case Dimensions and Data ==
* Dimensions: 329mm x 220mm x 12mm (WxDxH)
* Weight: 1.26Kg
* Screws
** Philips head type screws
** M2 flat head machine screws (measurements in mm)
** 4 x Small screws (used along the front edge): Head - 3.44, Thread Diameter - 1.97, Thread Length - 2.1, Overall length - 3.05
** 6 x Large screws: Head - 3.44, Thread Diameter - 1.97, Thread Length - 4.41, Overall Length - 5.85
* Rubber Feet
** 18mm diameter
** 3mm height
** Dome shaped

== SoC and Memory Specification ==
[[File:Rockchip_RK3399.png|right]]
* Based on Rockchip RK3399

=== CPU Architecture ===
* big.LITTLE architecture: Dual Cortex-A72 + Quad Cortex-A53, 64-bit CPU
** Full implementation of the ARM architecture v8-A instruction set (both AArch64 and AArch32)
** ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
** ARMv8 Cryptography Extensions
** VFPv4 floating point unit supporting single and double-precision operations
** Hardware virtualization support
** TrustZone technology support
** Full CoreSight debug solution
** One isolated voltage domain to support DVFS
* Cortex-A72 (big cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a72 Dual-core Cortex-A72 up to 2.0GHz CPU]
** Superscalar, variable-length, out-of-order pipeline
** L1 cache 48KB Icache and 32KB Dcache for each A72
** L2 cache 1024KB for big cluster
* Cortex-A53 (little cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a53 Quad-core Cortex-A53 up to 1.5GHz CPU]
** In-order pipeline with symmetric dual-issue of most instructions
** L1 cache 32KB Icache and 32KB Dcache for each A53
** L2 cache 512KB for little cluster
* Cortex-M0 (control processors):
** [https://developer.arm.com/ip-products/processors/cortex-m/cortex-m0 Cortex-M0 CPU]
** Two Cortex-M0 cooperate with the central processors
** Architecture: Armv6-M
** Thumb/Thumb2 instruction set
** 32 bit only

=== GPU Architecture ===
* [https://developer.arm.com/products/graphics-and-multimedia/mali-gpus/mali-t860-and-mali-t880-gpus ARM Mali-T860MP4 Quad-core GPU]
* The highest performance GPUs built on Arm Mali’s famous Midgard architecture, the Mali-T860 GPU is designed for complex graphics use cases and provide stunning visuals for UHD content.
* Frequency 650MHz
* Throughput 1300Mtri/s, 10.4Gpix/s
* Graphic interface standards:
** OpenGL® ES 1.1, 1.2, 2.0, 3.0, 3.1, 3.2. (Panfrost has initial support of 3.0 beginning 2020/02/27)
** Vulkan 1.0, using the Mali binary blob. (Panfrost does not support Vulkan as of 2020/06/24)
** OpenCL™ 1.1, 1.2
** DirectX® 11 FL11_1
** RenderScript™

=== System Memory ===
* RAM Memory:
** LPDDR4
** 800MHz, (limited by RK3399)
** Dual memory channels on the CPU, each 32 bits wide
** Quad memory channels on the RAM chip, each 16 bits wide, 2 bonded together for each CPU channel
** 4GB as a single 366 pin mobile RAM chip
* Storage Memory:
** 64GB eMMC module, can be upgraded to an 128GB eMMC module. (The initial PINE64 community build version shipped with a 128GB eMMC.)
** eMMC version 5.1, HS400, 8 bit on RK3399 side
** Bootable
* SPI flash:
** [[Pinebook Pro SPI]]
** 128Mbit / 16MByte
** 1 bit interface
** Bootable, (first boot device, ahead of eMMC & SD card)
** U-Boot images can be made to work, but as of 2020/06/24 there is no standardized image available.

=== Video out ===
* USB-C Alt mode DP
* Up to 3840x2160 p60, dependant on adapter, (2 lanes verses 4 lanes)

=== Expansion Ports ===
* MicroSD card:
** Bootable
** Supports SD, SDHC and SDXC cards, up to 512GB tested. SDXC standard says 2TB is the maximum.
** Version SD3.0, (MMC 4.5), up to 50MB/s
** SD card Application Performance Class 1 (A1), (or better), recommended by some users, for better IOPS
* USB ports:
** 1 x USB 2.0 Type-A Host Port, bootable
** 1 x USB 3.0 Type-A Host Port, 5Gbps, is not bootable
** 1 x USB 3.0 Type-C OTG Port, 5Gbps, (includes laptop charging function), is not bootable
** Note that high power USB devices may not work reliably on a PBP. Or they may draw enough power to drain the battery even when the PBP is plugged into A.C. One alternative is externally powered USB devices.
* Headphone jack switchable to UART console mux circuit

== Additional hardware ==
Hardware that is not part of the SoC.

=== Battery ===
* Lithium Polymer Battery (10,000 mAH)

=== Display ===
* 14.0" 1920x1080 IPS LCD panel
=== Lid closed magnet ===
There is a magnet to detect when the laptop lid is closed, so action can be taken like sleep. This meets up with the Hall sensor on the daughter / small board to detect lid closed.
* The magnet is located on the LCD panel right side, around 1.5 inches up measure from bottom edge.

=== Webcam ===
* Internal USB attached Webcam

=== Audio ===
* 3.5mm stereo earphone/microphone plug
* Built-in microphone
* Built-in stereo speakers:
** Oval in design
** 3 mm high x 20 mm x 30 mm

=== Network ===
* WiFi:
** 802.11 b/g/n/ac
** Dual band: 2.4Ghz & 5Ghz
** Single antenna
* Bluetooth 5.0

=== Optional NVMe adapter ===
* PCIe 1.1, 2.5 GT/s per lane
** Note that due to errata, PCIe is limited to Gen1. See [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/arch/arm64/boot/dts/rockchip/rk3399.dtsi?id=712fa1777207c2f2703a6eb618a9699099cbe37b this commit].
* Four PCIe lanes, which can not be bifurcated, but can be used with one- or two-lane NVMe cards
* '''M''' keyed, though '''M'''+'''B''' keyed devices will work too
* Maximum length for M.2 card is 80mm (M.2 2280). The following sizes will also work: 2230, 2242, 2260
* Power: 2.5 W continuous, 8.25 W peak momentary
* Does not support SATA M.2 cards
* Does not support USB M.2 cards

== Pinebook Pro Schematics and Certifications ==
* Pinebook Pro Main Board Schematic And Silkscreen:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_mainboard_schematic.pdf Pinebook Pro Main Board ver 2.1 Schematic]
** [https://wiki.pine64.org/images/3/30/Pinebookpro-v2.1-top-ref.pdf Pinebook Pro ver 2.1 Top Layer Silkscreen]
** [https://wiki.pine64.org/images/b/b7/Pinebookpro-v2.1-bottom-ref.pdf Pinebook Pro ver 2.1 Bottom Layer Silkscreen]
* Pinebook Pro Daughter Board Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_daughterboard_schematic.pdf Pinebook Pro Daughter Board ver 2.1 Schematic]
* Optional Pinebook Pro NVMe Adapter Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_NVMe-adapter_schematic.pdf Pinebook Pro NVMe Adapter Board ver 2.1 Schematic]
* Serial Console Earphone Jack Pinout:
** [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pinkbook Serial Console Earphone Jack Pinout]
* Pinebook Pro Case:
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.pdf AutoCAD PDF File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.ai AutoCAD AI File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.dwg AutoCAD DWG File ]
* Pinebook Pro Certifications:
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20FCC%20Certificate-S19071103501001.pdf Pinebook Pro FCC Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20CE%20RED%20Certificate-S19051404304.pdf Pinebook Pro CE Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20ROHS%20Compliance%20Certificate.pdf Pinebook Pro RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3399 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2016/0419/758.html Rockchip RK3399 SoC Brief]
** [https://opensource.rock-chips.com/images/d/d7/Rockchip_RK3399_Datasheet_V2.1-20200323.pdf Rockchip RK3399 Datasheet v2.1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.4%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.4, part 1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.3, part 1] and [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part2.pdf part 2]
** [https://files.pine64.org/doc/datasheet/rockpro64/RK808%20datasheet%20V0.8.pdf Rockchip RK808 Datasheet v0.8]
* LPDDR4 SDRAM (366-pin BGA):
** [https://files.pine64.org/doc/datasheet/PinebookPro/micron%20SM512M64Z01MD4BNK-053FT%20LPDDR4%20(366Ball).pdf Micron 366 balls 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/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 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://wiki.pine64.org/images/b/b9/Ds-00220-gd25q127c-rev1-df2f4.pdf GigaDevice 128Mb SPI Flash Datasheet (updated)]
* Wireless and Bluetooth information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/AP6256%20datasheet_V1.7_12282018.pdf AMPAK AP6256 11AC Wi-Fi + Bluetooth5 Datasheet]
* Audio codec:
** [http://www.everest-semi.com/pdf/ES8316%20PB.pdf Everest ES8316 Audio Codec Datasheet]
* LCD panel:
** [https://files.pine64.org/doc/datasheet/PinebookPro/NV140FHM-N49_Rev.P0_20160804_201710235838.pdf 14" 1920x1080 IPS LCD Panel datasheet]
* USB-related information:
** Internal USB 2.0 hub: [https://wiki.pine64.org/images/3/39/GL850G_USB_Hub_1.07.pdf GL850G USB Hub Datasheet]
** USB Type-C Controller: [https://www.onsemi.com/pub/Collateral/FUSB302-D.PDF ON Semiconductor FUSB302 Datasheet]
* Touchpad information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/YX%20HK-9562%20HID%20I2C%20Specification.pdf PineBook Pro Touchpad Specification]
* Keyboard information:
** [https://wiki.pine64.org/images/b/b0/SH68F83V2.0.pdf Sinowealth SH68F83 Datasheet]
** US ANSI: XK-HS002 MB27716023
* Full HD camera sensor:
** [https://files.pine64.org/doc/datasheet/PinebookPro/HK-2145-263.pdf Full HD Camera module specification (in Chinese)]
** [https://files.pine64.org/doc/datasheet/PinebookPro/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GalaxyCore GC2145 Full HD Camera Sensor Datasheet]
* Battery-related information:
** Battery charging IC: [https://www.ti.com/lit/ds/symlink/bq24171.pdf?ts=1607068456825&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FBQ24171 Texas Instruments BQ24171 Datasheet]
** Battery monitoring IC: [https://cdn.datasheetspdf.com/pdf-down/C/W/2/CW2015-Cellwise.pdf Cellwise CW2015 Datasheet]
** [https://files.pine64.org/doc/datasheet/pinebook/40110175P%203.8V%2010000mAh规格书-14.pdf 10000mAH Lithium Battery Specification]
* Power path device:
** [https://wiki.pine64.org/images/9/99/Sis412dn.pdf N-MOS / MOSFET]
* NVMe adapter:
** [https://wiki.pine64.org/images/d/d0/Hirose-FH26W-35S-0.3SHW%2860%29-datasheet.pdf FH26-35S-0.3SHW flat flex connector (compatible, not OEM)]

== Versions ==
Pinebook Pro v1 and v2 were prototype models that did not make it to the public. The "first batch" (First 100 forum preorders) onward are v2.1. [https://forum.pine64.org/showthread.php?tid=8111]

=Skinning and Case Customization=
* Template files for creating custom skins. Each includes template layers for art placement, and CUT lines.
**[https://drive.google.com/open?id=1UKFlC53DO0GJm3Hz1E_669n_HhI45e4n Case Lid Template]
**[https://drive.google.com/open?id=1Q6bKGarMDhvWz3HdGvhL5qDhyHb546ve Case Bottom Template]
**[https://drive.google.com/open?id=1ugI74ygNJ3EN5jXks5jKvdpEAoxIzHo4 Case Palmrest Template]

= Other Resources =
* [https://forum.pine64.org/forumdisplay.php?fid=111 Pinebook Pro Forum]
* [https://forum.pine64.org/forumdisplay.php?fid=98 ROCKPro64 Forum]
* [https://riot.im/app/#/room/#pinebook:matrix.org Matrix Channel] (no login required to read)
* IRC Server: irc.pine64.org Channel: PineBook
* [https://discordapp.com/channels/463237927984693259/622348681538043924 Discord Channel]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [[Pinebook Pro/Freepascal and Lazarus IDE on Manjaro|Freepascal and Lazarus IDE on Pinebook Pro]]

[[Category:PineBook Pro]]
[[Category:Rockchip RK3399]]

Pinebook Pro

2022-01-17T18:34:18Z

CameronNemo: /* Optional NVMe adapter */

= User Guide =
== Introducing PineBook Pro ==
[[File:PBP.jpg|400px|thumb|right|Pinebook Pro running Debian with MATE]]

The Pinebook Pro is a Linux and *BSD ARM laptop from [https://www.pine64.org/ PINE64]

It is built to be a compelling alternative to mid-ranged Chromebooks that people convert into Linux laptops. It features an IPS 1080p 14″ LCD panel, a premium magnesium alloy shell, high capacity eMMC storage, a 10,000 mAh capacity battery, and the modularity that only an open source project can deliver.

It's compact and slim dimensions are 329mm x 220mm x 12mm (WxDxH).

Key features include: the RK3399 SOC; USB-C for data, video-out and power-in (3A 5V); privacy switches for the microphone, BT/WiFi module, and camera; and expandable storage via NVMe (PCIe x4) with an optional adapter.

The Pinebook Pro is equipped with 4GB LPDDR4 system memory, high capacity eMMC flash storage, and 128Mb SPI boot Flash. The I/O includes: 1 x micro SD card reader (bootable), 1 x USB 2.0, 1 x USB 3.0, 1 x USB type C Host with DP 1.2 and power-in, PCIe x4 for an NVMe SSD drive (requires an optional adapter), and UART (via the headphone jack by setting an internal switch).

The keyboard and touchpad both use the USB 2.0 protocol. The LCD panel uses eDP MiPi display protocol.

Many different Operating Systems (OS) are freely available from the open source community and partner projects. These include various flavors of Linux (Ubuntu, Debian, Manjaro, etc.) and *BSD.

== Software and OS Image Downloads ==

=== Default Manjaro KDE Desktop Quick Start ===

When you first get your Pinebook Pro and boot it up for the first time, it'll come with Manjaro using the KDE desktop. The Pinebook Pro is officially supported by the Manjaro ARM project, and support can be found on the [https://forum.manjaro.org/c/manjaro-arm/78 Manjaro ARM forums.]

On first boot, it will ask for certain information such as your timezone location, keyboard layout, username, password, and hostname. Most of these should be self-explanatory. Note that the hostname it asks for should be thought of as the "codename" of your machine, and if you don't know what it's about, you can make something up (use a single word, all lower case, no punctuation; e.g. "pbpro").

After you're on the desktop, be sure to update it as soon as possible and reboot after updates are finished installing. If nothing appears when you click on the Networking icon in your system tray to connect to your Wi-Fi, ensure the Wi-Fi [https://wiki.pine64.org/index.php/Pinebook_Pro#ANSI_Fn_.2B_F_keys_wrong_for_F9.2C_F10.2C_F11_and_F12 privacy switch] is not disabled.

=== Pinebook Pro images ===
Under [[Pinebook Pro Software Release]] you will find a complete list of currently supported Operating System images that work with the Pinebook as well as other related software.

The list includes OS images and descriptions of:

* [[PinebookPro_Software_Release#Manjaro ARM|Manjaro ARM]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Armbian|Armbian]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Twister OS|Twister OS]] (microSD Boot)
* [[PinebookPro_Software_Release#Fedora|Fedora]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Arch_Linux_ARM|Arch Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#postmarketOS|Postmarket OS]] (microSD and USB boot)
* [[PinebookPro_Software_Release#Kali Linux|Kali Linux]] (microSD and USB boot)
* [[PinebookPro_Software_Release#DietPi|DietPi]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#Q4OS|Q4OS]] (microSD and eMMC Boot)
* [[PinebookPro_Software_Release#NetBSD|NetBSD]] (microSD and eMMC Boot)
* [[Pinebook_Pro_Software_Release#OpenBSD|OpenBSD release for ARM64]]
* [[Pinebook_Pro_Software_Release#Gentoo|Gentoo]]

== Keyboard ==
The Pinebook Pro is available in two keyboard configurations: ISO and ANSI. Both the keyboard and touchpad in the Pinebook Pro use the USB 2.0 protocol and show up as such in xinput. The keyboard features function (Fn) keys in the F-key row, which include display brightness controls, sound volume, touchpad lock, and other functionality. There is also a custom PINE64 logo key that functions as Menu/Super key. It has also a secondary functionality for setting the privacy switches.

The keyboard firmware binary can be flashed from userspace using the provided open source utility.

{{warning|DO NOT update the keyboard firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed, see the [https://reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Documentation for the keyboard can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]].

=== Typing special characters ===
The [[Wikipedia:British_and_American_keyboards#Other_keyboard_layouts|UK ISO Layout]] does not have dedicated keys for characters like the German umlauts (Ä,Ö,Ü, etc). Certain characters can still be generated by means of either key combinations or key sequences.
{| class="wikitable"
!Character
!Key combination/sequence
|-
|Ä, Ö, Ü, ä, ö, ü
|[[Wikipedia:AltGr_key|[AltGr]]]+'[' followed by [A], [O], [U], [a], [o] or [u]
|-
|µ
|[AltGr]+[m]
|-
|Ø, ø
|[AltGr]+[O], [AltGr]+[o]
|-
|@
|[AltGr]+[q] (as on the German layout)
|-
|ß
|[AltGr]+[s]
|-
|§
|[AltGr]+[S]
|-
|°
|[AltGr]+[)]
|}

=== Privacy Switches ===
There are three privacy switches mapped to the F10, F11 and F12 keys on the Pinebook Pro keyboard. They de/activate the following:

{| class="wikitable"
|+ Privacy switch function and description
! Combination
! Effect
! Description
! Notes
|-
! scope=row | PINE64 logo key+F10
| Microphone Privacy switch
| CAPs lock LED blinks. 2 blinks = enabled, 3 blinks = disabled
|-
! scope=row | PINE64 logo key+F11
| WiFi Privacy switch
| NUM lock LED blinks. 2 blinks = WiFi enabled / privacy switch disabled, 3 blinks = WiFi disabled / privacy switch enabled.
| '''Re-enabling requires reboot''' (or a [//forum.pine64.org/showthread.php?tid=8313&pid=52645#pid52645 command line hack to bind/unbind]).
|-
! scope=row | PINE64 logo key+F12
| Camera privacy switch
| CAPs lock and NUM lock LEDs blink together. 2 blinks = enabled, 3 blinks = disabled
| Can use tools like '''<code>lsusb</code>''' to detect camera's presence. If not detected, check privacy switch.
|}

'''(Press the PINE64 logo key plus F10/F11/F12) for 3 seconds)'''

The keyboard operates on firmware independent of the operating system. It detects if one of the F10, F11 or F12 keys is pressed in combination with the Pine key for 3 seconds. Doing so disables power to the appropriate peripheral, thereby disabling it. This has the same effect as cutting off the power to each peripheral with a physical switch. This implementation is very secure, since the firmware that determines whether a peripheral gets power is not part of the Pinebook Pro’s operating system. So the power state value for each peripheral cannot be overridden or accessed from the operating system. The power state setting for each peripheral is stored across reboots inside the keyboard's firmware flash memory.

=== Basic summary of replacing keyboard ===

This guide is very basic and should be fleshed out with (better) pictures. There just isn't a list of steps anywhere else yet.

Here's what the replacement keyboard looks like:

[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (front)]]
[[File:Pinebook_Pro_new_keyboard-front.jpg|300px|Replacement keyboard (back)]]

''Step 0'': If changing from ISO keyboard to ANSI keyboard, or vice versa, be sure to have a system capable of running the firmware updater that you can access either remotely or with a USB keyboard beyond the internal keyboard, as the firmware for each is very different and keys won't work correctly. See https://forum.pine64.org/showthread.php?tid=8407 (and for NetBSD, https://forum.pine64.org/showthread.php?tid=8716).

''Step 1'': The remove back back panel.

There are 10 screws on the back that must be removed, and the back panel detached. The speakers may remain attached via glue to the case and should be carefully pried off. When this is done, taking photos of how everything looks now can help put it all back together later.

[[File:Pinebook_Pro_keyboard-replacement-screws.jpg|300px|Remove the back panel]]

''Step 2'': Places to unscrew.

There are 3 items screwed into the keyboard frame that must be removed. There are 2 large screws for daughter board, 3 large screws and 1 small screw for mainboard, and 4 screws for battery. Be sure to not lose them.

[[File:Pinebook_Pro_new_keyboard-back-removed.jpg|300px|Remove the back panel]]

''Step 3'': Remove the battery.

Once the battery screws are removed, it should be unplugged from the mainboard and removed. Note that there are two unconnected cables lying around, that should remain unconnected. They are used when the battery is disconnected entirely.

[[File:Pinebook_Pro_new_keyboard-zoom-mainboard.jpg.jpg|300px|Zoom on the mainboard]]
[[File:Pinebook_Pro_new_keyboard-zoom-daughterboard.jpg|300px|Zoom on the daughterboard]]

''Step 4'': Unplug the ribbon cables.

There are several ribbon cables. To remove, flip up the tab and gentle pull the ribbon out.

* One cable runs from the mainboard to the daughterboard underneath the battery. Detach from both ends. With the battery removed, detach from keyboard shell, and set aside for the new keyboard shell.
* One cable runs between the touchpad and the mainboard. Detach from both ends, and also set aside.
* One cable runs between the keyboard and the mainboard. This one remains attached to the keyboard and only needs to be detached from the mainboard.
* One cable from the LCD attaches near the lid hinge. It should be just unplugged.

''Step 5'': Detach microphone and speakers.

[[File:Pinebook_Pro_microphone_removed.jpg|300px|thumb|right|One of the Pinebook Pro microphones after removal]]

The speakers and microphone don't have to be detached from the mainboard, but they need to be detached from the keyboard shell. The microphones are held in place by tape, and the speakers have sticky sides. The speakers are found obviously, but the microphones (two of) can be found between the battery and the hinge area. Each microphone can be carefully pulled/wedged out of its position by a small screwdriver or pick.

''Step 6'': Remove mainboard and daughterboard.

At this point, the mainboard and daughterboards should be removed. When unscrewed (see Step 2) they should pull out fairly easily. Put them aside (including microphones and speakers if left attached.)

[[File:Pinebook_Pro_new_keyboard-all-boards-removed.jpg|300px|All boards removed]]

''Step 7'': Detach the LCD panel.

Step 2 didn't tell you, there are 6 more screws to remove here, 3 for each of the hinges. Unscrew these and the LCD panel will be able to be removed. You may have to jiggle or move the hinges for this. When detached, be sure to place the LCD panel such that the display is protected.

[[File:Pinebook_Pro_new_keyboard-detached-display.jpg|300px|Display detached]]
[[File:Pinebook_Pro_new_keyboard-detached-display2.jpg|300px|Display detached (front)]]

''Step 8'': Try Not To Break Your Touchpad, or, How I Learned To Love Things That Bend

'''NOTE This section really feels like you're going to break something.'''

The touchpad is glued to the keyboard shell and it's glued well. There are two places it is glued to. If you can, only the middle must be force-detached. You will think you're going to break it. Gently apply increasing force until the glue begins to detach (you will hear a crackle as it comes off), and continue very slowly until the whole thing is detached. This may take minutes due to that feeling you're going to break it.

[[File:Pinebook_Pro_new_keyboard-touchpad1.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad2.jpg|300px|Unmouting the touchpad]]
[[File:Pinebook_Pro_new_keyboard-touchpad3.jpg|300px|Unmouting the touchpad]]

''Step 9'': Over the hill, touchpad goes into new shell.

In the new keyboard shell put the touchpad back where it was, hopefully the glue will remain sufficiently attached. If there is a glue issue, this guide unfortunately has no advice currently.

[[File:Pinebook_Pro_new_keyboard-install-touchpad.jpg|300px|Install the touchpad]]

''Step 10'': Reattach the LCD panel.

The LCD panel should slot back into the keyboard frame, the same way it came out. If the hinges were moved, they should be *very* *gently* closed such that the LCD panel and keyboard closed like normal for the remaining steps.

''Step 11'': Tape it out.

Move any tape from the old keyboard shell to the new one. These items protect the mainboard and daughterboard, and keep various wires in their right place. Some are grey and some are black. For tape that holds the speakers, microhones, or their cables in place, do not reattach yet.

''Step 12'': Board install.

Install the mainboard, the daughtboard, and their connecting ribbon cable. Be sure to put the boards in place, 2 large flat screws for the daughterboard, 3 large flat screws and one small screw for the mainboard, before attempting to place the ribbon.

''Step 13'': Microphone and speaker install.

Reattached the microphones and speakers to their respective areas, making sure that both are properly oriented - the speaker "out" faces up, and the microphone cables as connected must face up (these are opposite directions.)

''Step 14'': Reattach other ribbon cables.

The LCD panel, keyboard and touchpad ribbon cables should be reattached. Make sure the flap is open, insert the ribbon into the slot (a portion of the cable will disappear), and push the flap down. The cable should not be easy to pull out.

''Step 15'': Reattach the battery, and final re-tape.

The battery should be installed with the 4 screws holding it in place, and the connector attached to the mainboard. Be sure to keep the two other cables remain unconnected. Ensure all wires and other tapes are held in place.

''Step 16'': Reattach the back panel.

Put the back panel back on, and reattach the 10 screws.

''Step 17'': If you changed from ISO to ANSI or from ANSI to ISO, you'll need to update your firmware now. See the links in Step 0 above.

== Touchpad (trackpad) ==
Documentation for the touchpad can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]]. It is the only component of the Pinebook Pro held in place with strong adhesive tape. Here are some of its features:

* 2 actuating buttons.

* multi-touch functionality.

* A matte finish that your finger can slide along easily.

* A reasonable size (96mm × 64mm; diagonal: 115.378mm or 4.542”).

=== Troubleshooting ===

If you are having trouble using 2 fingers to scroll or emulate the click of a mouse's right-button, then try these solutions:

* Update the firmware.

* Keep your 2 fingers spread apart rather than close together.

* Individual programs might need to be configured specially.

:* For smooth scrolling and gestures under X-Windows, ''Firefox'' should be launched with with the following environment variable assignment:

::: <code>MOZ_USE_XINPUT2=1</code>

* Experiment with other settings, via [[#X-Windows Configuration|X-Windows Configuration]] or some other system preferences; for example, you could disable double-finger scrolling, and instead enable scrolling by sliding one finger along the edge of the touchpad.

=== Firmware ===
The touchpad controller is connected to the keyboard controller. All touchpad events go through the keyboard controller and it's software, then to the keyboard controller's USB port. Note that the touchpad does have separate firmware, (which has to be written through the keyboard controller). The touchpad vendor’s firmware binary can be flashed from userspace using the following open source command-line utility:

* Kamil Trzciński’s [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater pinebook-pro-keyboard-updater].

Naturally, forks have begun to appear:

* Jack Humbert’s [https://github.com/jackhumbert/pinebook-pro-keyboard-updater fork]

* Dragan Simic’s [https://github.com/dragan-simic/pinebook-pro-keyboard-updater fork]. This one has recently delivered a much improved firmware from the vendor, which greatly improves the control of the cursor (see this [https://forum.pine64.org/showthread.php?tid=14531 thread] for discussion); before installing this update, consider resetting to the defaults any configuration of your touchpad.

'''Every Pinebook Pro produced before September 2021 should have its keyboard and touchpad firmware updated.'''

{{warning| DO NOT update the touchpad firmware before checking which keyboard IC your Pinebook Pro has. Some Pinebook Pro were delivered with a '''SH61F83''' instead of a '''SH68F83'''. The SH61F83 can only be written 8 times, this will render the keyboard and touchpad unusable if this limit is reached when <code>step-1</code> is flashed. See [//old.reddit.com/r/PINE64official/comments/loq4db/very_disappointed/ Reddit SH61F83 thread]. The keyboard IC corresponds to <code>U23</code> on the [[#Pinebook_Pro_Schematics_and_Certifications|top layer silkscreen of the main board]]. It is located under the keyboard flat flexible cable.}}

Before updating ''any'' firmware, your Pinebook Pro should be either fully charged or, preferably, running from mains. This utility will be writing data to chips on the keyboard and touchpad, so a loss of power during any stage of the update can result in irrecoverable damage to your touchpad or keyboard.

The scripts ought to work on all OSs available for the Pinebook Pro. Some OSs may, however, require installation of relevant dependencies. The instructions below assume a Debian desktop. To install these dependencies, newer Pinebook Pro models that come with Manjaro will require a different command.

There are two keyboard versions of the Pinebook Pro: ISO and ANSI. You need to know which model you have prior to running the updater.
Firmware update steps for both models are listed below.

What you will need:

* Connection to WiFi (for getting dependencies).

* Your Pinebook Pro fully charged or running from mains power.

* An external USB keyboard & mouse (or access to the Pinebook Pro via SSH. Please note that for some configurations, the SSH service might not be available without first having logged in once; in this case, you will definitely want at least an external keyboard).

==== ISO Model ====

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 iso
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 iso
sudo poweroff # do not use 'reboot'
</pre>

==== ANSI Model ====

{{Hint| Note: Running step 1 on the ANSI keyboard model will make the keyboard and touchpad inaccessible until step 2 is ran, so an external keyboard must be connected to complete the update on this model!}}

From the terminal command line:

<pre>
git clone https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater
cd pinebook-pro-keyboard-updater
sudo apt-get install build-essential libusb-1.0-0-dev xxd
make
</pre>

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 ansi
sudo poweroff # do not use 'reboot'
</pre>

Step 2 (after booting)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 ansi
sudo poweroff # do not use 'reboot'
</pre>

When done, if some of the keys produce incorrect characters, please check your OS’s language settings. For ANSI users, the default OS may have shipped with English UK as the default language; you can change it to English US if desired.

==== Revised Firmware ====

In addition, you might consider using revised firmware data; this is one final step that should not require a reboot:

Step 3: '''ISO''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_iso.hex
</pre>

Step 3: '''ANSI''' (after booting)
<pre>
sudo ./updater flash-kb firmware/default_ansi.hex
</pre>

=== X-Windows Configuration ===
''Before making adjustments, consider updating the firmware; reset your adjustments before updating the firmware, so that your adjustments do not interfere with new functionality.''

Some forum members have found that an adjustment to X-Windows will allow finer motion in the touchpad. If you use the '''Synaptic''' mouse/touchpad driver, use this command to make the change live:
<pre>synclient MinSpeed=0.25</pre>
You may experiment with different settings, but 0.25 was tested as helping noticeably. 
 
To make the change persist across reboots, change the file <code>/etc/X11/xorg.conf</code> similar to below:
<pre> Section "InputClass"
Identifier "touchpad catchall"
Driver "synaptics"
MatchIsTouchpad "on"
MatchDevicePath "/dev/input/event*"
Option "MinSpeed" "0.25"
EndSection</pre>
The line <code>Option "MinSpeed" "0.25"</code> is the change. 
 
Another forum user built on the above settings a little, and have found these to be very good:
<pre>synclient MinSpeed=0.25
synclient TapButton1=1
synclient TapButton2=3
synclient TapButton3=2
synclient FingerLow=30
synclient PalmDetect=1
synclient VertScrollDelta=64
synclient HorizScrollDelta=64</pre>

<code>FingerLow</code> has the same value as 'FingerHigh' in one config (30). It is believed to help reduce mouse movement as you lift your finger, but it's unknown whether synaptic works like this.
You may find this config to be comfortable for daily use.
 

<code>TabButton</code> allows to just tab the touchpad instead of physically pressing it down (to get this click noise).

The <code>right mouse click</code> is emulated by tapping with two fingers on the touchpad. If you feel that this is not very responsive you can try this value:
<pre> synclient MaxTapTime=250 </pre>

Some users may encounter an issue with the mouse jumping when typing when using libinput driver (has not been test with synaptic) due to their hand hitting the touchpad which can be fixed by updating the xorg settings to disable it while typing. One can disable the touchpad while typing by setting the below option in the xorg config simliar to the previou example.

<pre>
Option "DisableWhileTyping" "on"
</pre>

The setting can be verified by using the xinput command to first list the devices and then listing the properties for the Touchpad device. Exact commands to check this have been omitted for save of brevity. If DisableWhileTyping is shown enabled but does not appear to be working the issue may be due to the fact that the keyboard is connected to a USB bus which causes it to be seen as a external keyboard. To resolve this one can add the config below which sets the keyboard to internal to ensure the DisableWhileTyping works properly.

You will need to edit <code>/etc/libinput/local-overrides.quirks</code> and add the following lines:
<pre>
[Serial Keyboards]
MatchUdevType=keyboard
MatchBus=usb
AttrKeyboardIntegration=internal
</pre>

Once X11 is restarted the new setting should now take effect and you will no longer be able to use the touchpad while typing which will mostly eliminate the mouse jumping issue.

== Power Supply ==
* Input Power: 5V DC @ 3A
* Mechanical: 3.5mm OD / 1.35mm ID, Barrel jack
* USB-C 5V, 15W PD quickcharge
* Only use one power input at a time, barrel jack OR USB-C

== LEDs ==
In total, there are four LEDs on the Pinebook Pro, three of which are placed in the top-left side of the keyboard, and one near the barrel port:

# The red LED next to the barrel port indicates charging, in three ways. First, it will illuminate steadily when either the factory power supply or a USB Type-C charger is connected to the Pinebook Pro, and the battery is getting charged. Second, if the battery is at 100%, the LED will remain turned off regardless of the connected power input; however, this is [https://forum.pine64.org/showthread.php?tid=10899 rather rarely achieved]. Third, this LED will flash at 0.5 Hz if there are any problems that prevent charging, such as the battery becoming too hot.
# The power indicator LED, above the keyboard, supports three different colors: green, amber and red. It is also capable of flashing to indicate eMMC activity. In the default Debian with MATE build, green LED means power and red means suspend (amber is unused).
# The green NumLock LED, above the keyboard.
# The green CapsLock LED, above the keyboard.

The NumLock and CapsLock LEDs serve their usual purposes on a keyboard, but they also have a secondary function. When the privacy switches get activated they blink to confirm that the switch has been activated.

== Webcam ==
{{Hint| You can use Cheese to test the Camera functionality}}
* Streaming video resolutions supported, (uncompressed):
** 320 x 240
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Still frame resolutions supported:
** 160 x 120
** 176 x 144
** 320 x 240
** 352 x 288
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200

== Microphones ==
While it has been said that some Pinebook Pro units contain only one microphone despite having two labeled microphone holes on the outer casing, other units do indeed contain two microphones. It is presently unclear which batches have either configuration; units from the initial community batch of 1000 units (following the initial 100) are believed to contain two, populating both labeled holes.

The wires leading to both microphones connect to the mainboard with a small white plastic connector, located directly adjacent to the ribbon cable attachment point for the keyboard interface.

'''Microphones not working?'''

If pavucontrol input doesn't show microphone activity try changing the [[Pinebook_Pro#Privacy_Switches|privacy switches]]. If the switches are in the correct place and microphone input isn't working you can run <code>alsamixer</code> from the command line, hit F6 and select the es8316, hit F4 to get to the capture screen, select the bar labeled ADC, increase the gain to 0dB, change the audio profile in pavucontrol to another one with input. Additionally you may want to modify ADC PGA to get the levels to where you want them. If that still hasn't fixed it you may want to check that the microphone connector is plugged in (see the section [[#Technical Reference|Technical Reference]]).

== Bluetooth and WiFi ==
[[File:PinebookPro_WirelessIC_Location.jpg|400px|thumb|right|The Pinebook Pro's AP6256 wireless module]]
===Hardware Overview===
The Pinebook Pro contains an AMPAK AP6256 wireless module to provide Wi-Fi (compliant to IEEE 802.11ac) and Bluetooth (compliant to Bluetooth SIG revision 5.0). The module contains a Broadcom transceiver IC, believed to be the BCM43456, as well as the support electronics needed to allow the Wi-Fi and Bluetooth modes to share a single antenna.

The wireless module interfaces with the Pinebook Pro’s system-on-chip using a combination of three interfaces: Bluetooth functionality is operated by serial UART and PCM, while the Wi-Fi component uses SDIO. It is unknown if the module’s Bluetooth capabilities are usable under operating systems that do not support SDIO.

The module’s RF antenna pin is exposed on the mainboard via a standard Hirose U.FL connector, where a coaxial feedline links it to a flexible adhesive antenna situated near the upper right corner of the Pinebook Pro’s battery. As the RF connector is fragile and easily damaged, it should be handled carefully during connection and disconnection, and should not be reconnected frequently.

===Issues===
Problems have been reported with the Wi-Fi transceiver’s reliability during extended periods of high throughput, especially on the 2.4 GHz band. While the cause of this has yet to be determined, switching to the 5 GHz band may improve stability.

Since the Bluetooth transceiver shares both its spectrum and antenna with 2.4 GHz Wi-Fi, simultaneous use of these modes may cause interference, especially when listening to audio over Bluetooth. If Bluetooth audio cuts out frequently, switching to the 5 GHz band – or deactivating Wi-Fi – may help.

===Wi-Fi Capabilities===
Wi-Fi on the Pinebook Pro is capable of reaching a maximum data transfer rate of approximately 433 megabits per second, using one spatial stream. The transceiver does not support multiple spatial streams or 160-MHz channel bandwidths.

The Wi-Fi transceiver supports the lower thirteen standard channels on the 2.4 GHz band, using a bandwidth of 20 MHz. At least twenty-four channels are supported on the 5 GHz band, spanning frequencies from 5180 to 5320 MHz, 5500 to 5720 MHz, and 5745 to 5825 MHz, with bandwidths of 20, 40, or 80 MHz.

Maximum reception sensitivity for both bands is approximately -92 dBm. The receiver can tolerate input intensities of no more than -20 dBm on the 2.4 GHz band, and no more than -30 dBm on the 5 GHz band. Maximum transmission power is approximately +15 dBm for either band, falling further to approximately +10 dBm at higher data transfer rates on the 5 GHz band.

With current available drivers and firmware, the Wi-Fi interface supports infrastructure, ad-hoc, and access-point modes with satisfactory reliability. Monitor mode is not presently supported. Wi-Fi Direct features may be available, but it is unclear how to make use of them under Linux.

Be aware that Linux userspace utilities, such as <code>iw</code>, may report inaccurate information about the capabilities of wireless devices. Parameter values derived from vendor datasheets, or direct testing, should be preferred to the outputs of hardware-querying tools.

===Bluetooth Capabilities===
Bluetooth data transfer speeds have an indicated maximum of 3 megabits per second, but it is unclear what practical data rates can be expected. Audio streaming over Bluetooth is functioning normally, as is networking. Bluetooth Low-Energy functions, such as interacting with Bluetooth beacons, have not yet been tested conclusively.

The Bluetooth transceiver supports all 79 channel allocations, spanning frequencies from 2402 MHz to 2480 MHz. Reception sensitivity is approximately -85 dBm, with a maximum tolerable reception intensity of -20 dBm. Bluetooth transmission power is limited to +10 dBm.

===Disabling Bluetooth===

To disable Bluetooth under Linux once:

sudo rfkill block bluetooth

To confirm if Bluetooth under Linux is disabled:

rfkill

To disable Bluetooth on boot (note: for distributions such as Manjaro XFCE see the step below):

sudo systemctl enable rfkill-block@bluetooth

To disable Bluetooth on certain distributions, such as Manjaro XFCE, right click on the Bluetooth panel icon, select plugins, then PowerManager, then configuration and then deselect the auto power on option

== LCD Panel ==
* Model: BOE NV140FHM-N49
* 14.0" (35.56 cm) diagonal size
* 1920x1080 resolution
* 60 Hz refresh rate
* IPS technology
* 1000:1 contrast
* 250 nit brightness
* 63% sRGB coverage
* 6-bit color
* 30-pin eDP connection

Some people have tested hardware video decode using the following;

<pre>ffmpeg -benchmark -c:v h264_rkmpp -i file.mp4 -f null -</pre>

== External ports list ==
Here are a list of the external ports. See [[Pinebook_Pro#Expansion_Ports|Technical Reference - Expansion Ports]] for port specifications.
* Left side
** Barrel jack for power, (with LED)
** USB 3, Type A
** USB 3, Type C
* Right side
** USB 2, Type A
** Standard headset jack
** MicroSD card slot

== Using the UART ==
[[File:PinePhone_Serial_Cable.png|400px|thumb|right|Pinout of the serial adapter. Swapping the tx and rx around from this also works and is more traditional. See the official [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pine64 document].]]

UART output is enabled by flipping the UART switch to the ON position (item 9). To do so you need to remove the Pinebook Pro's bottom cover - please follow [[Pinebook_Pro#Disassembly_and_Reassembly|proper disassembly and reassembly protocol]]. The OFF position is towards the touchpad, the ON position is towards the display hinges.

With the UART switch in the ON position, console is relayed via the audiojack and the laptop's sound is turned OFF. Please ensure that you are using a 3.3 V interface (such as the CH340, FTDI-232R, or PL2303, which are sold in both 3.3 V and 5 V variants) to avoid damage to the CPU. Older version of the serial console cable sold by Pine64 uses wrong voltage level and should not be used; see [https://forum.pine64.org/showthread.php?tid=9367 this forum thread] for further information. Recent version of the same cable uses the right voltage level.

Insert the USB plug of the cable into an open USB port on the machine which will monitor, ensuring that the audio jack of the serial cable is be fully inserted into the Pinebook Pro audio port. Run the following in a terminal:

<code>
$ lsusb
</code>

you should find a line similar to this:

<code>
Bus 001 Device 058: ID 1a86:7523 QinHeng Electronics HL-340 USB-Serial adapter
</code>

Serial output should now be accessible using screen, picocom or minicom (and others).
Examples:

<code>
screen /dev/ttyUSB0 1500000

picocom /dev/ttyUSB0 -b 1500000

minicom -D /dev/ttyUSB0 -b 1500000</code>

Old versions of U-Boot do not use the UART for console output. <strike>The console function is activated by the Linux kernel. Thus, if you use a non-Pinebook Pro Linux distro and want the UART as a console, you have to manually enable it.</strike>

== Using the optional NVMe adapter ==
The optional NVMe adapter allows the use of M.2 cards that support the NVMe standard, (but not SATA standard). The optional NVMe M.2 adapter supports '''M''' & '''M'''+'''B''' keyed devices, in both 2242 & 2280 physical sizes, the most common ones available. In addition, 2230 & 2260 are also supported, though NVMe devices that use those sizes are rare.

Once you have fitted and tested your NVMe drive, please add a note to this page [[Pinebook Pro Hardware Accessory Compatibility]] to help build a list of tried and tested devices.

Please see [[Pinebook Pro Troubleshooting Guide#NVMe SSD issues|a separate section]] that describes reported issues with the NVMe drives in PineBook Pro.

=== Installing the adapter ===
The V2.1-2019-0809 SSD adapter that shipped with the initial Pinebook Pro batches had significant issues. A repair kit will be shipped to address those issues.
(If necessary, it can be modified to work. There is [https://forum.pine64.org/showthread.php?tid=8322&pid=52700#pid52700 an unofficial tutorial on the forums] describing these modifications.)

The updated SSD adapter, labeled V2-2019-1107, takes into account the prior problems with touchpad interference. New orders as of Feb. 22nd, 2020 will be the updated adapter.

This is the link to the Pinebook Pro accessories in the store: [[https://pine64.com/?v=0446c16e2e66]]

Actual installation instructions are a work in progress. Unofficial instructions for installing V2-2019-1107 can be found [https://eli.gladman.cc/blog/2020/06/23/pine-book-pro-nvme.html here].

=== Post NVMe install power limiting ===
Some NVMe SSDs allow reducing the maximum amount of power. Doing so may reduce the speed, but it may be needed in the Pinebook Pro to both improve reliability at lower battery levels. And to reduce power used, to maintain battery life.
Here are the commands to obtain and change the power settings. The package 'nvme-cli' is required to run these commands. The example shows how to find the available power states, and then sets it to the lowest, non-standby setting, (which is 3.8 watts for the device shown);

<pre>$ sudo nvme id-ctrl /dev/nvme0
NVME Identify Controller:
...
ps 0 : mp:9.00W operational enlat:0 exlat:0 rrt:0 rrl:0
rwt:0 rwl:0 idle_power:- active_power:-
ps 1 : mp:4.60W operational enlat:0 exlat:0 rrt:1 rrl:1
rwt:1 rwl:1 idle_power:- active_power:-
ps 2 : mp:3.80W operational enlat:0 exlat:0 rrt:2 rrl:2
rwt:2 rwl:2 idle_power:- active_power:-
ps 3 : mp:0.0450W non-operational enlat:2000 exlat:2000 rrt:3 rrl:3
rwt:3 rwl:3 idle_power:- active_power:-
ps 4 : mp:0.0040W non-operational enlat:6000 exlat:8000 rrt:4 rrl:4
rwt:4 rwl:4 idle_power:- active_power:-

$ sudo nvme get-feature /dev/nvme0 -f 2
get-feature:0x2 (Power Management), Current value:00000000
$ sudo nvme set-feature /dev/nvme0 -f 2 -v 2 -s
set-feature:02 (Power Management), value:0x000002</pre>
Some NVMe SSDs don't appear to allow saving the setting with "-s" option. In those cases, leave off the "-s" and use a startup script to set the non-default power state at boot. 
If you want to test performance without saving the new power setting semi-permanantly, then leave off the "-s" option. 
 
There is another power saving feature for NVMes, APST, (Autonomous Power State Transitions). This performs the power saving & transitions based on usage. To check if you have a NVMe SSD with this feature;
<pre>$ sudo nvme get-feature -f 0x0c -H /dev/nvme0</pre>
Information for this feature, (on a Pinebook Pro), is a work in progress.

=== Using as data drive ===
As long as the kernel in use has both the PCIe and NVMe drivers, you should be able to use a NVMe drive as a data drive. It can automatically mount when booting from either the eMMC or an SD card. This applies to Linux, FreeBSD, and Chromium, using the normal partitioning and file system creation tools. Android requires testing.

=== Using as OS root drive ===
The SoC does not include the NVMe boot code, so the NVMe is not in the SoC's boot order. However, using the [https://github.com/mrfixit2001/updates_repo/blob/v1.1/pinebook/filesystem/mrfixit_update.sh U-Boot update script] from the mrfixit2001 Debian or [https://pastebin.com/raw/EeK074XB Arglebargle's modified script], and [https://github.com/pcm720/rockchip-u-boot/releases the modified u-boot images] provided by forum user pcm720, you can now add support to boot from an NVMe drive. Binary images are useable with SD, eMMC, and [[Pinebook_Pro_SPI|SPI flash]]. For OS images using the mainline kernel, there are a few variants of U-Boot available that also support NVMe as the OS drive. Though these may require writing the U-Boot to the SPI flash for proper use of the NVMe as the OS drive.

The current boot order, per last testing, for this modified U-Boot is:
*MicroSD
*eMMC
*NVMe

For more information, please refer to [https://forum.pine64.org/showthread.php?tid=8439&pid=53764#pid53764 the forum post.]

It is also possible to initially boot off an eMMC or SD card, then transfer to a root file system on the NVMe. Currently, it is necessary to have the U-Boot code on an eMMC or SD card. (A forum member [https://forum.pine64.org/showthread.php?tid=8439 posted here] about using a modified version of U-Boot with NVMe drivers, that uses <code>/boot</code> and <code>/</code> off the NVMe drive. So this may change in the future.)

Please see [[Pinebook_Pro#Bootable Storage|Bootable Storage]].

== Caring for the PineBook Pro ==
=== Bypass Cables ===
The mainboard features two (disconnected by default) bypass cables that are only to be used with the battery disconnected. The female (10) male (6) ends of the bypass cables can be connected to provide power to the mainboard if you need to run the laptop without a battery. Please refer to this [https://files.pine64.org/doc/PinebookPro/PinebookPro_Engineering_Notice.pdf engineering notice].

'''Note that despite the bypass cable being a two conductor cable, it is only used as one. Both wires being soldered together on either side is normal!'''

{{warning|Do not connect the bypass cables with the battery connected. Using the bypass cables with the battery connected can permanently damage the computer.}}

=== Pinebook Service Step-by-Step Guides ===

Under [[Pinebook_Service_Step_by_Step_Guides|Service Guides for Pinebook]] you can find instructions guides concerning disassembly of:

* The installation process on Pinebook Pro similar to 14" Pinebook
* The installation process is the reverse order of removal guide:
** 14″ Pinebook Lithium Battery Pack Removal Guide
** 14″ Pinebook LCD Panel Screen Removal Guide
** 14″ Pinebook eMMC Module Removal Guide

== Using the SPI flash device ==

See [[Pinebook Pro SPI]] for details.

The Pinebook Pro comes with a 128Mbit, (16MByte), flash device suitable for initial boot target, to store the bootloader. The SoC used on the Pinebook Pro boots from this SPI flash device first, before eMMC or SD card. At present, April 19, 2020, the Pinebook Pros ship without anything programmed in the SPI flash device. So the SoC moves on to the next potential boot device, the eMMC. ARM/ARM64 computers do not have a standardized BIOS, yet.

Here is some information on using the SPI flash device:

* You need the kernel built with SPI flash device support, which will supply a device similar to: code>/dev/mtd0</code>
* The Linux package below, will need to be available: <code>mtd-utils</code>
* You can then use this program from the package to write the SPI device: <code>flashcp <filename> /dev/mtd0</code>

Even if you need to recover from a defective bootloader written to the SPI flash, you can simply short pin 6 of the SPI flash to GND and boot. This will render the SoC bootrom unable to read from the SPI flash and have it fall back to reading the bootloader from other boot media like the eMMC or Micro SD card.

The procedures described above are a lot less risky than attaching an external SPI flasher and do not require any additional hardware. At present, April 19th, 2020, there is no good bootloader image to flash into the SPI flash device. This is expected to change, as there are people working on issue.

= Software tuning guide =
Details on how to get the most out of a Pinebook Pro & its RK3399 SoC.

== Customizing the Pinebook Pro's default Manjaro KDE system ==
=== Watching DRM content (Netflix, etc.) ===
Most paid online streaming services use Widevine DRM to make their content more difficult to pirate. Widevine is not directly supported on Manjaro KDE, however it is still possible to watch DRM content via the "chromium-docker" package which downloads a 32-bit ARM container and installs Chromium with Widevine inside of that. While not space-efficient, or efficient in general, it's the recommended solution for watching this content on your Pinebook Pro. You can install this package with:
<pre>sudo pacman -Sy chromium-docker</pre>

=== Checking GPU capabilities ===
To see what versions of OpenGL and OpenGL ES are supported by the Pinebook Pro, what driver is in use, and what version of the driver is loaded, install the "mesa-demos" package with:
<pre>sudo pacman -Sy mesa-demos</pre>
And then run:
<pre>glxinfo | grep OpenGL</pre>
This will give detailed information about your graphics card and driver, useful for debugging.

=== Better GPU compatibility and performance ===
For better graphics performance, you may install the "mesa-git" package, built and supplied in the Manjaro ARM repos. This lets you bring in the latest features, optimizations, and bugfixes for the graphics driver used by the Pinebook Pro. Installation is as simple as:
<pre>pacman -Sy mesa-git</pre>
Then you may reboot to load the newer driver.

With Mesa 20.2 there is no longer much reason to use this over the standard mesa package, and applications may occasionally break with mesa-git.

[https://docs.mesa3d.org/bugs.html Reporting bugs] to the Mesa project will help make sure any problems are quickly fixed.

=== OpenGL 3.3 support ===
By default, with the current state of the Panfrost GPU driver, the Pinebook Pro supports OpenGL 2.1 and OpenGL ES 3.0. If you want to use OpenGL 3.3, you need to set the system-wide environment variable, open the '''/etc/environment''' file with:
<pre>kate /etc/environment</pre>
And then at the bottom of the file, on a new line, add:
<pre>PAN_MESA_DEBUG="gl3"</pre>
Then save the file, entering your password when prompted, and reboot the system. When you check your GPU capabilities, it should report OpenGL 3.3 and applications that rely on it should function properly. Note that GL 3.3 support is incomplete and some rendering features do not work yet, notably geometry shaders.

=== Install Anbox on Pinebook Pro Manjaro 20.10 ===
[https://www.youtube.com/watch?v=EU8_Q11dATs Youtube video on installing Anbox on Pienbook Pro Manjaro Build 20.10 by LivingLinux]

== Customizing the Pinebook Pro's previously-default Debian system ==
Here are some hints on what you can do to customize the Pinebook Pro's previous factory image (aka [https://github.com/mrfixit2001/debian_desktop mrfixit2001 debian build])

=== Initial user changes, password, name, etc ===
When you first get your Pinebook Pro, you should consider setting strong passwords and making the default account your own.

* Reboot (this is just to ensure all background processes belong to the user are not running... there are other ways to achieve this but this way is easy)
* Once the machine reboots press Alt-Ctrl-F1 to bring up a text terminal
* Login as root (login: root, password: root)
* Set a strong password for the root user using the following command and it's prompts:
<pre># passwd (and follow prompts)</pre>
* Rename the rock user to your prefered username (replace myself with whatever you like):
<pre># usermod -l myself -d /home/myself -m rock</pre>
* Rename the rock group to match your preferred username:
<pre># groupmod -n myself rock</pre>
* Put your name in the account, (replace "John A Doe" with your name):
<pre># chfn -f "John A Doe" myself</pre>
* Set a strong password for the normal user:
<pre># passwd myself</pre>
* Log out of the text terminal:
<pre># logout</pre>
* Press Alt-Ctrl-F7 to go back to the login screen and then login as the normal user
* Open text terminal to fix login error: "Configured directory for incoming files does not exist";
<pre>$ blueman-services</pre>
Select "Transfer" tab and set "Incoming Folder" to myself
OR
If adduser is in distro, this is MUCH easier
sudo adduser $USER ,, fill out requested data
Then,, sudo adduser $USER $GROUP,,, 1 group at a time
To see which groups to add,,, id $USER, id rock

=== Changing the default hostname ===
Debian 9 has a command to allow you to change the hostname. You can see the current settings using;
<pre>$ sudo hostnamectl
Static hostname: Debian-Desktop
Icon name: computer
Machine ID: dccbddccbdccbdccbdccbdccbdccbccb
Boot ID: ea99ea99ea99ea99ea99ea99ea99ea99
Operating System: Debian GNU/Linux 9 (stretch)
Kernel: Linux 4.4.210
Architecture: arm64</pre>
To change, use this, (with "My_Hostname" used as the example);
<pre>$ sudo hostnamectl set-hostname My_Hostname</pre>
Whence done, you can re-verify using the first example.

Then you should backup and edit your <code>/etc/hosts</code> entry's name;
<pre>$ sudo cp -p /etc/hosts /etc/hosts.`date +%Y%m%d`
$ sudo vi /etc/hosts
127.0.0.1 localhost
127.0.0.1 My_Hostname
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
127.0.1.1 linaro-alip</pre>

=== Disable Chromium browser's prompt for passphrase & password storage ===

Perform the following steps:

* On the tool bar, hover over the Chromium icon
* Using the right mouse button, select '''Properties'''
* In the '''Command:''' line section, add <code>--password-store=basic</code> before the <code>%U</code>
* Use the '''x Close''' button to save the change
This will of course, use basic password storage, meaning any saved passwords are not encrypted. Perfectly fine if you never use password storage.

=== Changing the boot splash picture ===

The default boot splash picture can be replaced using the following instructions:

* Install '''ImageMagick''' which will do the conversion
<pre>$ sudo apt-get install imagemagick</pre>
* Create a 1920 x 1080 picture. For the best results, use a PNG image (It supports lossless compression).
* From the directory in which your new image is stored run the following commands
* Convert your image to the bootsplash raw format using imagemagick convert.
<pre>$ convert yoursplashimage.png -separate +channel -swap 0,2 -combine -colorspace sRGB RGBO:splash.fb</pre>
* Create a backup copy of your current splash screen
<pre>$ sudo cp /usr/share/backgrounds/splash.fb /usr/share/backgrounds/splash_original.fb</pre>
* Copy your new splash screen into place
<pre>$ sudo cp splash.fb /usr/share/backgrounds/splash.fb</pre>
* Set the correct permissions on the splash.fb file
<pre>$ sudo chmod 644 /usr/share/backgrounds/splash.fb</pre>
* If you do not want to see kernel console text messages, make sure you don't have '''Plymouth''' installed

=== Watching Amazon Prime videos with Chromium ===
When you create a new user, it will be necessary to launch the Chromium browswer with a specific user agent like below;
<pre>chromium-browser --user-agent="Mozilla/5.0 (X11; CrOS armv7l 6946.63.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36"</pre>
There may be more tweaks needed.

=== Enabling text boot time messages ===

By default, most Linux distros have a boot screen with a picture. To see all the boot time messages, use one of the following;

==== Debian ====
* Backup and edit the U-Boot configuration file:

cp -p /etc/default/u-boot /etc/default/u-boot.`date +%Y%m%d`
chmod a-w /etc/default/u-boot.`date +%Y%m%d`
vi /etc/default/u-boot

Remove the '''quiet''' and '''splash''' parameters. Leave everything else alone.

* Update the U-Boot configuration:

u-boot-update

* Test and verify you get what you think you should be seeing.

==== Manjaro ====
* Backup and edit the U-Boot configuration file:

cp -p /boot/extlinux/extlinux.conf /boot/extlinux/extlinux.conf.`date +%Y%m%d`
chmod a-w /boot/extlinux/extlinux.conf.`date +%Y%m%d`
vi /boot/extlinux/extlinux.conf

* Change '''console=ttyS2,1500000''' to '''console=tty1'''
* Remove the '''bootsplash.bootfile''' option and it's parameter.
* You can add verbose logging by appending '''ignore_loglevel''' to the line where boot splash was.
* Leave everything else alone.
* Test and verify you get what you think you should be seeing.

== Improving readability ==

Some people find that a 14" LCD screen with 1080p, (1920 x 1080), has text and icons a bit too small. There are things you can do to make the screen easier to use and read. 
* Increase the font size
* Use a font with more pronounced features
* Increase the various window manager sizes (e.g. increase the height of the tool bar)
* Change the color scheme to be easier on the eyes. Higher contrast can help usability.
* Change the window manager's decorations (e.g. use larger icons)
* Use a workspace manager, with one application per workspace
* When at home or office, use an external monitor
* Change the X-Windows DPI. One such method that someone used successfully, is: <blockquote><code>echo "Xft.dpi: 150" >> ~/.Xresources</code></blockquote>Change the 150 as desired to get the size adjustment you want.
 
However, do not change the resolution of the LCD screen, otherwise you may end up with a blank / black screen. If that happens, see this troubleshooting section for the fix: 
[[Pinebook_Pro#After_changing_builtin_LCD_resolution.2C_blank_screen|Blank screen after changing builtin LCD resolution]]

== Chromium tweaks ==

=== Flags ===

From the [https://github.com/mrfixit2001/updates_repo/blob/v1.8/pinebook/filesystem/default official Debian image]:

<pre>
--disable-low-res-tiling \
--num-raster-threads=6 \
--profiler-timing=0 \
--disable-composited-antialiasing \
--test-type \
--show-component-extension-options \
--ignore-gpu-blacklist \
--use-gl=egl \
--ppapi-flash-path=/usr/lib/chromium-browser/pepper/libpepflashplayer.so \
--ppapi-flash-version=32.0.0.255 \
--enable-pinch \
--flag-switches-begin \
--enable-gpu-rasterization \
--enable-oop-rasterization \
--flag-switches-end
</pre>

Note that in some cases, this may also decrease performance substantially, as observed when using these flags on the Manjaro KDE desktop. Feel free to experiment to find what is smoothest for you personally.

== gVim has performance issue ==
It appears that using GTK3 can cause very slow scrolling, while Vim in a terminal window works fine. 
Simply revert back to using GTK2, (how to do so is somewhat Linux distro-specific).

Another solution may be to run gVim with

GDK_RENDERING=image

environment variable set. It seems that this improves the performance by reverting back to software-only rendering.

== Kernel options ==
Here are some Pinebook Pro & its RK3399 SoC Linux specific options. If kernel version, (or version range specific), it should list that information in the description.

To see if a specific feature is enabled in the current kernel, you can use something like this;

<pre>
$ zgrep -i rockchip_pcie /proc/config.gz
# CONFIG_ROCKCHIP_PCIE_DMA_OBJ is not set
CONFIG_PHY_ROCKCHIP_PCIE=m
</pre>
If it's listed as <code>=m</code>, then it's a module. You can see if the module is loaded with;
<pre>
$ lsmod | grep -i rockchip_pcie
phy_rockchip_pcie 16384 0
</pre>
Note modules are not loaded until needed. Thus, we sometimes check the kernel configuration instead to see if a feature is configured first, then see if it's a module.

=== Hardware video decoding ===
Here is a method to check for hardware video decoding by the VPU. There are special Linux kernel modules that perform this function. 
Older systems, such as the previously-default Debian desktop, use the Rockchip-supplied kernel module <code>rk-vcodec</code>. To check, something like this can be used:
<pre>
$ lsmod | grep rk-vcodec
or
$ zgrep RK_VCODEC /proc/config.gz
CONFIG_RK_VCODEC=y
</pre>
Note that in the above example, the Rockchip video CODEC is not built as a module, but included into the kernel. Thus, it does not show up in the list modules check. 
 

Newer systems may use a different option as in the configuration below:
<pre>
$ zgrep HANTRO /proc/config.gz
CONFIG_VIDEO_HANTRO=m
CONFIG_VIDEO_HANTRO_ROCKCHIP=y
</pre>

= Troubleshooting guide =

Do not to panic if something goes wrong or in an unexpected way. Instead, stop and consider carefully how to undo something, or how to redo it. This particularly applies when flashing a new operating system, or flashing new firmware to the keyboard or touchpad. If everything fails, consider reporting the issue on the forums, with as many relevant details as available.

Please, have a look at the [[Pinebook Pro Troubleshooting Guide]], which details a number of issues you may encounter.

= Hardware/Accessory Compatibility =
Please contribute to the [[Pinebook Pro Hardware Accessory Compatibility|hardware/accessory compatibility page]], which lists the status of hardware tested with the Pinebook Pro. Available hardware categories include the following:

* [[Pinebook Pro Hardware Accessory Compatibility#NVMe SSD drives|NVMe SSD drives]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB hardware|USB hardware]]
* [[Pinebook Pro Hardware Accessory Compatibility#USB C alternate mode DP|USB-C alternate mode DP]]
* [[Pinebook Pro Hardware Accessory Compatibility#Other hardware|Other hardware]]

= Technical Reference =
== Disassembly and Reassembly ==
[[File:Standoffs.png|400px|thumb|right|Pinebook Screw stand-offs correct placement and location]]

[[File:Hinges_cover_removed_1.jpeg|300px|thumb|right|Hinge area of the Pinebook Pro lid with the cover removed]]
[[File:Hinges_cover_removed_2.jpeg|300px|thumb|right|Close-up of a Pinebook Pro lid hinge]]

There are a few '''mandatory''' precautions to be taken:

* Do not open the laptop by lifting the lid while the Pinebook Pro bottom cover is removed - this can cause structural damage to the hinges and/or other plastic components of the chassis such as the IO port cut-outs.
* When removing the back cover plate, *do not, under any circumstances, slide your fingertips between the metal shell and the plastic frame!* The back cover plate edges are sharp, and when combined with the pressure and movement generated from, specifically, attempting to slide the tips of your fingers along the bottom edge of the plate along the lid-hinge, they *will* slice open the tips of your fingers like a knife.
* When removing the back cover plate, use care to avoid damaging the speakers. They can be stuck to the back cover with double-sided tape, and the thin wires are very delicate. Newer Pinebook Pro laptops (as of the May 2021 batch, and perhaps earlier) seem to lack the double-sided tape to the rear cover, instead opting for tape or glue that makes them stick to the front cover. Nevertheless, be gentle when removing the back cover.

[[File:PinebookProScrewGuide.png|400px|thumb|right|Pinebook Pro external screws (this particular unit has suffered damage on screw (4)L)]]

When disassembling the laptop make sure that it is powered off and folded closed. To remove the bottom cover of the Pinebook Pro, first remove the ten (10) Phillips head screws that hold the bottom section of the laptop in place. There are four (4) short screws along the front edge, and six (6) long screws along the 3 remaining sides. Remove the cover from the back where the hinges are situated by lifting it up and away from the rest of the chassis. The aluminum case is held on only by screws. There are no plastic snaps, and the shell should pull away without any effort. If you experience any resistance at all stop and ensure all ten (10) screws are accounted for.

During reassembly, make sure that the back-screw standoffs are in place and seated correctly. Before replacing the aluminum back-plate, ensure that the speakers are properly seated by pressing gently on the hard plastic edge of the speaker module. Slide the bottom section into place so it meets the front lip of the keyboard section. Secure the front section (where the touchpad is located) in place using the short screws in the front left and right corners. Then proceed to pop in the bottom panel into place. Secure the bottom section (where hinges are located) by screwing in the left and right corners. Then screw in the remaining screws and run your finger though the rim on the chassis to make sure its fitted correctly. Note that the front uses the remaining 4 short screws.

The screws are small and should only be finger tight. Too much force will strip the threads. If after installing screws the back cover plate has not seated properly on one side (which may be caused by the aforementioned misseating of the speakers), open the display and hold the base on either side of the keyboard and gently flex the base with both hands in opposing directions. Once the side pops further in, then recheck the screws on that side. If it does not pop back in, re-open the machine and check for misseated components.

A basic 3D model to print replacement standoffs for the back cover screws is [https://www.thingiverse.com/thing:4226648 available on Thingiverse], until the official drawings or 3D models are made available.

====Display Disassembly====
It is not recommended to adjust the position of the lid when the bottom cover is removed, because the bottom cover provides structural strength, so the lid should be open fully as the first step, before starting any disassembly of the laptop. After opening the lid, remove the bottom cover by following the instruction found in the section above. Alternatively, you can keep the lid closed and remove the screws that hold the hinges to the main laptop body, as described in [[Pinebook Service Step by Step Guides]].

Parts of the hinge mechanism, as well as the screws that hold the hinges to the lid, are hidden behind an elongated plactic U-shaped cover that snaps in place using latches. Use a dedicated plastic prying tool or a guitar pick to gently pry the cover and remove it, starting from the outer edge. Once you pry the cover to a certain extent, it should be possible to remove it fully using only your hands. The U-shaped cover is rather sturdy, but still be careful not to break or bend it.

There are two small screws hidden underneath the two small rubber nubs on the upper part of the screen bezel, so first gently remove the nubs and then remove the screws. The screen bezel is held in place with a combination of latches and some adhesive tape, which is there to prevent dust ingress. The adhesive isn't very strong, and the bezel is capable of flexing back into shape after being twisted to a certain extent. There is more adhesive on the bottom part of the screen bezel, so be more careful while prying that section apart. Use the same prying tool that you used for the U-shaped cover, and work it around the outer edges of the screen bezel.

== Internal Layout ==

=== Main chips ===
* RK3399 system-on-chip (1)
* LPDDR4 SDRAM (21)
* SPI NOR flash memory (29)
* eMMC flash memory (26)
* WiFi/BT module (27)

=== Mainboard Switches and Buttons ===
There are two switches on the main board: disabling the eMMC (24), and enabling UART (9) via headphone jack.

The Reset and Recovery buttons (28): the reset button performs an immediate reset of the laptop. The Recovery button is used to place the device in maskrom mode; this mode allows flashing eMMC using Rockchip tools (e.g. rkflashtools).

[[File:PBPL_S.jpg]]

=== Key Internal Parts ===
{| class="wikitable"
|+ Numbered parts classification and description
! Number
! Type
! Descriptor
|-
! scope=row | 1
| Component || RK3399 System-On-Chip
|-
! scope=row | 2
| Socket || PCIe x4 slot for optional NVMe adapter
|-
! scope=row | 3
| Socket || Speakers socket
|-
! scope=row | 4
| Socket || Touchpad socket
|-
! scope=row | 5
| Component || Left speaker
|-
! scope=row | 6
| Connector || Power bridge connector
|-
! scope=row | 7
| Socket || Keyboard Socket
|-
! scope=row | 8
| Component || Optional NVMe SSD adapter
|-
! scope=row | 9
| Switch || UART/Audio switch - outputs UART via headphone jack
|-
! scope=row | 10
| Socket || Power bridge socket
|-
! scope=row | 11
| Socket || Battery socket
|-
! scope=row | 12
| Component || Touchpad
|-
! scope=row | 13
| Component || Battery
|-
! scope=row | 14
| Component || Right speaker
|-
! scope=row | 15
| Socket || MicroSD card slot
|-
! scope=row | 16
| Socket || Headphone / UART jack
|-
! scope=row | 17
| Socket || USB 2.0 Type A
|-
! scope=row | 18
| Socket || Daughterboard-to-mainboard ribbon cable socket
|-
! scope=row | 19
| Cable || Daughterboard-to-mainboard ribbon cable
|-
! scope=row | 20
| Component || microphone
|-
! scope=row | 21
| Component || LPDDR4 RAM
|-
! scope=row | 22
| Socket || Mainboard-to-daughterboard ribbon cable socket
|-
! scope=row | 23
| Socket || Microphone socket
|-
! scope=row | 24
| Switch || Switch to hardware disable eMMC
|-
! scope=row | 25
| Antenna || BT/WiFI antenna
|-
! scope=row | 26
| Component || eMMC flash memory module
|-
! scope=row | 27
| Component ||BT/WiFi module chip
|-
! scope=row | 28
| Buttons || Reset and recovery buttons
|-
! scope=row | 29
| Component || SPI flash storage
|-
! scope=row | 30
| Socket || eDP LCD socket
|-
! scope=row | 31
| Socket || Power in barrel socket
|-
! scope=row | 32
| Socket || USB 3.0 Type A
|-
! scope=row | 33
| Socket || USB 3.0 Type C
|}

=== Smallboard detailed picture ===

[[File:Pinebook_pro_smallboard.jpg]]

== Bootable Storage ==

=== Boot sequence details ===
The RK3399's mask 32KB ROM boot code looks for the next stage of code at byte off-set 32768, (sector 64 if using 512 byte sectors). This is where U-Boot code would reside on any media that is bootable. 
[[RK3399_boot_sequence|RK3399 boot sequence]]

=== Boot devices ===

The Pinebook Pro is capable of booting from eMMC, USB 2.0, USB 3.0, or an SD card. It cannot boot from USB-C. The boot order of the hard-coded ROM of its RK3399 SoC is: SPI NOR, eMMC, SD, USB OTG.

At this time, the Pinebook Pro ships with a Manjaro + KDE build with [https://www.denx.de/wiki/U-Boot/ u-boot] on the eMMC. Its boot order is: SD, USB, then eMMC.

(An update has been pushed for the older Debian + MATE build that improves compatibility with booting other OSes from an SD card. In order to update, fully charge the battery, establish an internet connection, click the update icon in the toolbar, and then reboot your Pinebook Pro. Please see [https://forum.pine64.org/showthread.php?tid=7830 this log] for details.)

Please note that PCIe, the interface used for NVMe SSD on the Pinebook Pro, is not bootable on the RK3399 and therefore is not a part of the boot hierarchy. It is possible to run the desired OS from NVMe by pointing extlinux on the eMMC to rootfs on the SSD. This requires uboot, the Kernel image, DTB, and extlinux.conf
in a /boot partition on the eMMC.

=== eMMC information ===
The eMMC appears to be hot-pluggable. This can be useful if trying to recover data or a broken install. Best practice is probably to turn the eMMC switch to off position before changing modules. Note that the enable/disable label on the silkscreen is incorrect on some board revisions (known bad on v2.1).

The eMMC storage will show up as multiple block devices:
*mmcblk1boot0 - eMMC standard boot0 partition, may be 4MB
*mmcblk1boot1 - eMMC standard boot1 partition, may be 4MB
*mmcblk1rpmb - eMMC standard secure data partition, may be 16MB
*mmcblk1 - This block contains the user areas

Only the last is usable as regular storage device in the Pinebook Pro.
The device number of "1" shown above may vary, depending on kernel.

If the eMMC module is enabled after boot from an SD card, you can detect this change with the following commands as user "root";
<pre>
echo fe330000.sdhci >/sys/bus/platform/drivers/sdhci-arasan/unbind
echo fe330000.sdhci >/sys/bus/platform/drivers/sdhci-arasan/bind
</pre>

== Case Dimensions and Data ==
* Dimensions: 329mm x 220mm x 12mm (WxDxH)
* Weight: 1.26Kg
* Screws
** Philips head type screws
** M2 flat head machine screws (measurements in mm)
** 4 x Small screws (used along the front edge): Head - 3.44, Thread Diameter - 1.97, Thread Length - 2.1, Overall length - 3.05
** 6 x Large screws: Head - 3.44, Thread Diameter - 1.97, Thread Length - 4.41, Overall Length - 5.85
* Rubber Feet
** 18mm diameter
** 3mm height
** Dome shaped

== SoC and Memory Specification ==
[[File:Rockchip_RK3399.png|right]]
* Based on Rockchip RK3399

=== CPU Architecture ===
* big.LITTLE architecture: Dual Cortex-A72 + Quad Cortex-A53, 64-bit CPU
** Full implementation of the ARM architecture v8-A instruction set (both AArch64 and AArch32)
** ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
** ARMv8 Cryptography Extensions
** VFPv4 floating point unit supporting single and double-precision operations
** Hardware virtualization support
** TrustZone technology support
** Full CoreSight debug solution
** One isolated voltage domain to support DVFS
* Cortex-A72 (big cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a72 Dual-core Cortex-A72 up to 2.0GHz CPU]
** Superscalar, variable-length, out-of-order pipeline
** L1 cache 48KB Icache and 32KB Dcache for each A72
** L2 cache 1024KB for big cluster
* Cortex-A53 (little cluster):
** [https://developer.arm.com/products/processors/cortex-a/cortex-a53 Quad-core Cortex-A53 up to 1.5GHz CPU]
** In-order pipeline with symmetric dual-issue of most instructions
** L1 cache 32KB Icache and 32KB Dcache for each A53
** L2 cache 512KB for little cluster
* Cortex-M0 (control processors):
** [https://developer.arm.com/ip-products/processors/cortex-m/cortex-m0 Cortex-M0 CPU]
** Two Cortex-M0 cooperate with the central processors
** Architecture: Armv6-M
** Thumb/Thumb2 instruction set
** 32 bit only

=== GPU Architecture ===
* [https://developer.arm.com/products/graphics-and-multimedia/mali-gpus/mali-t860-and-mali-t880-gpus ARM Mali-T860MP4 Quad-core GPU]
* The highest performance GPUs built on Arm Mali’s famous Midgard architecture, the Mali-T860 GPU is designed for complex graphics use cases and provide stunning visuals for UHD content.
* Frequency 650MHz
* Throughput 1300Mtri/s, 10.4Gpix/s
* Graphic interface standards:
** OpenGL® ES 1.1, 1.2, 2.0, 3.0, 3.1, 3.2. (Panfrost has initial support of 3.0 beginning 2020/02/27)
** Vulkan 1.0, using the Mali binary blob. (Panfrost does not support Vulkan as of 2020/06/24)
** OpenCL™ 1.1, 1.2
** DirectX® 11 FL11_1
** RenderScript™

=== System Memory ===
* RAM Memory:
** LPDDR4
** 800MHz, (limited by RK3399)
** Dual memory channels on the CPU, each 32 bits wide
** Quad memory channels on the RAM chip, each 16 bits wide, 2 bonded together for each CPU channel
** 4GB as a single 366 pin mobile RAM chip
* Storage Memory:
** 64GB eMMC module, can be upgraded to an 128GB eMMC module. (The initial PINE64 community build version shipped with a 128GB eMMC.)
** eMMC version 5.1, HS400, 8 bit on RK3399 side
** Bootable
* SPI flash:
** [[Pinebook Pro SPI]]
** 128Mbit / 16MByte
** 1 bit interface
** Bootable, (first boot device, ahead of eMMC & SD card)
** U-Boot images can be made to work, but as of 2020/06/24 there is no standardized image available.

=== Video out ===
* USB-C Alt mode DP
* Up to 3840x2160 p60, dependant on adapter, (2 lanes verses 4 lanes)

=== Expansion Ports ===
* MicroSD card:
** Bootable
** Supports SD, SDHC and SDXC cards, up to 512GB tested. SDXC standard says 2TB is the maximum.
** Version SD3.0, (MMC 4.5), up to 50MB/s
** SD card Application Performance Class 1 (A1), (or better), recommended by some users, for better IOPS
* USB ports:
** 1 x USB 2.0 Type-A Host Port, bootable
** 1 x USB 3.0 Type-A Host Port, 5Gbps, is not bootable
** 1 x USB 3.0 Type-C OTG Port, 5Gbps, (includes laptop charging function), is not bootable
** Note that high power USB devices may not work reliably on a PBP. Or they may draw enough power to drain the battery even when the PBP is plugged into A.C. One alternative is externally powered USB devices.
* Headphone jack switchable to UART console mux circuit

== Additional hardware ==
Hardware that is not part of the SoC.

=== Battery ===
* Lithium Polymer Battery (10,000 mAH)

=== Display ===
* 14.0" 1920x1080 IPS LCD panel
=== Lid closed magnet ===
There is a magnet to detect when the laptop lid is closed, so action can be taken like sleep. This meets up with the Hall sensor on the daughter / small board to detect lid closed.
* The magnet is located on the LCD panel right side, around 1.5 inches up measure from bottom edge.

=== Webcam ===
* Internal USB attached Webcam

=== Audio ===
* 3.5mm stereo earphone/microphone plug
* Built-in microphone
* Built-in stereo speakers:
** Oval in design
** 3 mm high x 20 mm x 30 mm

=== Network ===
* WiFi:
** 802.11 b/g/n/ac
** Dual band: 2.4Ghz & 5Ghz
** Single antenna
* Bluetooth 5.0

=== Optional NVMe adapter ===
* PCIe 1.1, 2.5 GT/s per lane
** Note that due to errata, PCIe is limited to Gen1. See [https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/arch/arm64/boot/dts/rockchip/rk3399.dtsi?id=712fa1777207c2f2703a6eb618a9699099cbe37b this commit].
* Four PCIe lanes, which can not be bifurcated, but can be used with one- or two-lane NVMe cards
* '''M''' keyed, though '''M'''+'''B''' keyed devices will work too
* Maximum length for M.2 card is 80mm (M.2 2280). The following sizes will also work: 2230, 2242, 2260
* Power: 2.5 W continuous, 8.25 W peak momentary
* Does not support SATA M.2 cards
* Does not support USB M.2 cards

== Pinebook Pro Schematics and Certifications ==
* Pinebook Pro Main Board Schematic And Silkscreen:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_mainboard_schematic.pdf Pinebook Pro Main Board ver 2.1 Schematic]
** [https://wiki.pine64.org/images/3/30/Pinebookpro-v2.1-top-ref.pdf Pinebook Pro ver 2.1 Top Layer Silkscreen]
** [https://wiki.pine64.org/images/b/b7/Pinebookpro-v2.1-bottom-ref.pdf Pinebook Pro ver 2.1 Bottom Layer Silkscreen]
* Pinebook Pro Daughter Board Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_daughterboard_schematic.pdf Pinebook Pro Daughter Board ver 2.1 Schematic]
* Optional Pinebook Pro NVMe Adapter Schematic:
** [https://files.pine64.org/doc/PinebookPro/pinebookpro_v2.1_NVMe-adapter_schematic.pdf Pinebook Pro NVMe Adapter Board ver 2.1 Schematic]
* Serial Console Earphone Jack Pinout:
** [https://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf Pinkbook Serial Console Earphone Jack Pinout]
* Pinebook Pro Case:
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.pdf AutoCAD PDF File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.ai AutoCAD AI File ]
** [https://files.pine64.org/doc/PinebookPro/drawings/Pinebook%20Pro%20Principle%20Views.dwg AutoCAD DWG File ]
* Pinebook Pro Certifications:
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20FCC%20Certificate-S19071103501001.pdf Pinebook Pro FCC Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20CE%20RED%20Certificate-S19051404304.pdf Pinebook Pro CE Certificate]
** [https://files.pine64.org/doc/cert/Pinebook%20Pro%20ROHS%20Compliance%20Certificate.pdf Pinebook Pro RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3399 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2016/0419/758.html Rockchip RK3399 SoC Brief]
** [https://opensource.rock-chips.com/images/d/d7/Rockchip_RK3399_Datasheet_V2.1-20200323.pdf Rockchip RK3399 Datasheet v2.1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.4%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.4, part 1]
** [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part1.pdf Rockchip RK3399 Technical Reference Manual v1.3, part 1] and [https://www.rockchip.fr/Rockchip%20RK3399%20TRM%20V1.3%20Part2.pdf part 2]
** [https://files.pine64.org/doc/datasheet/rockpro64/RK808%20datasheet%20V0.8.pdf Rockchip RK808 Datasheet v0.8]
* LPDDR4 SDRAM (366-pin BGA):
** [https://files.pine64.org/doc/datasheet/PinebookPro/micron%20SM512M64Z01MD4BNK-053FT%20LPDDR4%20(366Ball).pdf Micron 366 balls 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/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf 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://wiki.pine64.org/images/b/b9/Ds-00220-gd25q127c-rev1-df2f4.pdf GigaDevice 128Mb SPI Flash Datasheet (updated)]
* Wireless and Bluetooth information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/AP6256%20datasheet_V1.7_12282018.pdf AMPAK AP6256 11AC Wi-Fi + Bluetooth5 Datasheet]
* Audio codec:
** [http://www.everest-semi.com/pdf/ES8316%20PB.pdf Everest ES8316 Audio Codec Datasheet]
* LCD panel:
** [https://files.pine64.org/doc/datasheet/PinebookPro/NV140FHM-N49_Rev.P0_20160804_201710235838.pdf 14" 1920x1080 IPS LCD Panel datasheet]
* USB-related information:
** Internal USB 2.0 hub: [https://wiki.pine64.org/images/3/39/GL850G_USB_Hub_1.07.pdf GL850G USB Hub Datasheet]
** USB Type-C Controller: [https://www.onsemi.com/pub/Collateral/FUSB302-D.PDF ON Semiconductor FUSB302 Datasheet]
* Touchpad information:
** [https://files.pine64.org/doc/datasheet/PinebookPro/YX%20HK-9562%20HID%20I2C%20Specification.pdf PineBook Pro Touchpad Specification]
* Keyboard information:
** [https://wiki.pine64.org/images/b/b0/SH68F83V2.0.pdf Sinowealth SH68F83 Datasheet]
** US ANSI: XK-HS002 MB27716023
* Full HD camera sensor:
** [https://files.pine64.org/doc/datasheet/PinebookPro/HK-2145-263.pdf Full HD Camera module specification (in Chinese)]
** [https://files.pine64.org/doc/datasheet/PinebookPro/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GalaxyCore GC2145 Full HD Camera Sensor Datasheet]
* Battery-related information:
** Battery charging IC: [https://www.ti.com/lit/ds/symlink/bq24171.pdf?ts=1607068456825&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FBQ24171 Texas Instruments BQ24171 Datasheet]
** Battery monitoring IC: [https://cdn.datasheetspdf.com/pdf-down/C/W/2/CW2015-Cellwise.pdf Cellwise CW2015 Datasheet]
** [https://files.pine64.org/doc/datasheet/pinebook/40110175P%203.8V%2010000mAh规格书-14.pdf 10000mAH Lithium Battery Specification]
* Power path device:
** [https://wiki.pine64.org/images/9/99/Sis412dn.pdf N-MOS / MOSFET]
* NVMe adapter:
** [https://wiki.pine64.org/images/d/d0/Hirose-FH26W-35S-0.3SHW%2860%29-datasheet.pdf FH26-35S-0.3SHW flat flex connector (compatible, not OEM)]

== Versions ==
Pinebook Pro v1 and v2 were prototype models that did not make it to the public. The "first batch" (First 100 forum preorders) onward are v2.1. [https://forum.pine64.org/showthread.php?tid=8111]

=Skinning and Case Customization=
* Template files for creating custom skins. Each includes template layers for art placement, and CUT lines.
**[https://drive.google.com/open?id=1UKFlC53DO0GJm3Hz1E_669n_HhI45e4n Case Lid Template]
**[https://drive.google.com/open?id=1Q6bKGarMDhvWz3HdGvhL5qDhyHb546ve Case Bottom Template]
**[https://drive.google.com/open?id=1ugI74ygNJ3EN5jXks5jKvdpEAoxIzHo4 Case Palmrest Template]

= Other Resources =
* [https://forum.pine64.org/forumdisplay.php?fid=111 Pinebook Pro Forum]
* [https://forum.pine64.org/forumdisplay.php?fid=98 ROCKPro64 Forum]
* [https://riot.im/app/#/room/#pinebook:matrix.org Matrix Channel] (no login required to read)
* IRC Server: irc.pine64.org Channel: PineBook
* [https://discordapp.com/channels/463237927984693259/622348681538043924 Discord Channel]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [[Pinebook Pro/Freepascal and Lazarus IDE on Manjaro|Freepascal and Lazarus IDE on Pinebook Pro]]

[[Category:PineBook Pro]]
[[Category:Rockchip RK3399]]

Quartz64 Development

2021-11-21T19:29:19Z

CameronNemo: Config Options: mention reason for autoloading being broken

Quartz64 Development

2021-08-10T16:38:47Z

CameronNemo: /* Upstreaming Status */ Change color of u-boot status

Quartz64

2021-08-10T16:37:36Z

CameronNemo: /* SoC and Memory Specifications */

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
* [https://www.cnx-software.com/2020/12/01/rockchip-rk3568-processor-to-power-edge-computing-and-nvr-applications 22nm process, believed to be FD-SOI]

=== 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]]

Quartz64

2021-08-10T16:37:00Z

CameronNemo: /* CPU Architecture */ Add process info

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
* [https://www.cnx-software.com/2020/12/01/rockchip-rk3568-processor-to-power-edge-computing-and-nvr-applications 22nm process], believed to be FD-SOI

=== 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]]