PINE64 - User contributions [en]

PinePhone Pro/IMX258 Camera Debugging

2024-11-10T15:01:32Z

Diederik: /* Initial status */ Add note about DeviceTree *binding* which tells the DT description is lacking those voltage supply entries

{{Under construction}}

== Background ==

The Pinephone Pro's rear camera is a Sony IMX258. The camera driver is present upstream, and at least [https://gitlab.manjaro.org/manjaro-arm/packages/core/linux-pinephonepro Manjaro's kernel] (downstream of Megi's) enables the driver. The camera does not seem to work; this page catalogs work on figuring out why.

== Initial status ==

What do we see in dmesg?

<pre>
imx258 1-001a: supply vana not found, using dummy regulator
imx258 1-001a: supply vdig not found, using dummy regulator
</pre>

This tells us the kernel loads the driver, which is something.

Are these errors bad/fatal? Inspecting the [https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers/media/i2c/imx258.c?h=linux-6.6.y source] shows us that these supplies are defined in the <code>imx258_supply_names</code> array, and <code>imx258_probe</code> calls <code>devm_regulator_bulk_get</code> to set them up.
<code>imx258_probe</code> checks the return code from <code>devm_regulator_bulk_get</code>, emitting a fatal "Failed to get supplies" message if the return code is negative (indicating failure). Since we don't see this message (or any others from the driver), it looks like it loads successfully!

==== Note ====
The DeviceTree description of the Sony IMX258 Image Sensor should conform to its [https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/Documentation/devicetree/bindings/media/i2c/sony,imx258.yaml DeviceTree binding]. 
What those error messages tell you is that the <code>vana</code> and <code>vdig</code> supplies have NOT been defined in the DeviceTree description. The best thing to do would be to add those.

=== How can we test the camera? ===

==== Megapixels ====

[https://gitlab.com/postmarketOS/megapixels Megapixels] requires a per-device file to configure cameras. This one isn't complete (most of its numbers are complete nonsense), but it should let us see what happens when Megapixels tries to access the camera:
<code>pine64,pinephone-pro.ini</code>:
<pre>
[device]
make=PINE64
model=PinePhone Pro

[rear]
driver=imx258
media-driver=rkisp1
capture-width=4208
capture-height=3118
capture-rate=60
capture-fmt=GRBG10P
preview-width=1280
preview-height=960
preview-rate=60
#preview-fmt=BGGR8
capture-fmt=GRBG10P
rotate=90
mirrored=true
focallength=2.6
cropfactor=12.7
fnumber=2.8
flash-display=true
</pre>

This segfaulted Megapixels for me. After patching some trivial segfaults, I get fatal GTK4 issues and other tangential problems. Let's try something else.

==== Manually setting up a camera pipeline ====

We can roughly follow [https://www.kernel.org/doc/html/latest/admin-guide/media/rkisp1.html this guide]. Doing so gives us the following commands:
<pre>
"media-ctl" "-d" "platform:rkisp1" "-r"
"media-ctl" "-d" "platform:rkisp1" "-l" "'imx258 1-001a':0 -> 'rkisp1_isp':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":0 [fmt:SGRBG10_1X10/1048x780]'
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1048,height=780,"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":0 [fmt:SGRBG10_1X10/1048x780 crop:(0,0)/1048x780]'

"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=800,height=600,pixelformat=422P"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "1" "--verbose"
</pre>

Careful readers will note that this is setting the camera up with a low resolution compared to what the sensor can do. For some reason I can't get the rkisp1 node to configure its sink pad with the maximum resolution of the sensor (4208x3118). Instead, it sets itself to 4032x3024. This mismatch is forbidden and causes v4l2 to give us EPIPE when we try to enable the stream. Using the lower resolution gets us further--the last command (which attempts to save a single frame of video) gives output like this:
<pre>
VIDIOC_QUERYCAP: ok
VIDIOC_REQBUFS returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_STREAMON returned 0 (Success)
</pre>

But then it just hangs there indefinitely.

Running under strace, we see the program stuck in an ioctl:
<pre>
ioctl(3, VIDIOC_DQBUF, {type=V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE
</pre>

[https://www.kernel.org/doc/html/v6.6/userspace-api/media/v4l/vidioc-qbuf.html VIDIOC_DQBUF] corresponds to dequeuing a buffer once it has been filled with an image by the v4l2 device. Apparently, the device never gives us back a captured frame.

=== Now what? ===

==== Does i2c work at all? ====

The camera driver uses i2c; we can see the camera [https://github.com/megous/linux/blob/c5af9f4f874a66b65c73c450b79f6a86b1b46332/arch/arm64/boot/dts/rockchip/rk3399-pinephone-pro.dts#L890-L914 in the .dts] to determine that it's on i2c bus 1, address 0x1a.

The imx258 is controlled over i2c, and sends image data over MIPI. The first step is to see if the i2c control is working.

Looking back at the driver, it seems we should see errors in dmesg if i2c communication fails. The driver checks the chip id in its probe function, which uses i2c, so we can conclude that i2c gets set up properly initially. Does it keep working?

==== Does i2c keep working? (FTrace) ====

We can see if other functions that use i2c produce errors--for example, when we run our <code>"v4l2-ctl" ... "--stream-mmap"</code> command, we expect that <code>imx258_start_streaming</code> will get called, and this function also writes a load of registers over i2c.

Build and install a kernel with CONFIG_FTRACE (not hard, but outside the scope of this write-up) and enable function graph tracing:
<pre>
$ sudo su
# cd /sys/kernel/debug/tracing
# echo function_graph > current_tracer
# cat available_filter_functions | grep -E 'rkisp|imx258|v4l2' | awk '{print $1}' > set_graph_function
# echo 'vm_map_pages,__iommu_map,iommu_map_sg_atomic,rk_iommu_map,__alloc_pages,dma_alloc_attrs,dma_mmap_attrs,__vm_map_pages,vb2_mmap,clk_e,able,schedule_timeout,clk_disable,regmap_write,schedule,__i2c_tra,sfer,i2c_tra,sfer_buffer_flags,dma_free_attrs' | tr , '\n' > set_graph_notrace
# tee trace_pipe > ~/function-trace.log
</pre>

Now, in another terminal session, run the <code>"v4l2-ctl" ... "--stream-mmap"</code> command again. We end up with a bunch (but hopefully not *too* much) of output in our first terminal and the <code>~/function-trace.log</code> file.

A quick grep shows that <code>imx258_start_streaming</code> is indeed called, so '''i2c is working properly'''.

=== If i2c works, what doesn't? ===

Our program that asks for a video frame is still hung! We ask the camera to start streaming frames, it presumably does, but the v4l2 stack never tells us a frame has finished. Doing some digging in the v4l2 stack (and the rkisp1 driver), we find out that rkisp1 is notified about frame status via interrupts. We figure this out by manually backtracking through the code to see when <code>vb2_buffer_done</code>, the function in the vb2 API to call when a frame is finished, would be called. In the rkisp1 code, <code>vb2_buffer_done</code> is only called from <code>rkisp1_handle_buffer</code> which is only called from <code>rkisp1_capture_isr</code>, which (for the PPP's rk3399 SoC) is only called from <code>rkisp1_isr</code>, which is an interrupt handler. We know that it's an interrupt handler from the name (<code>_isr</code>), but also because it gets passed (indirectly) to <code>devm_request_irq</code> by way of being the <code>.isr</code> field of <code>rk3399_isp_isrs</code>.

Perhaps the hardware is never actually emitting the interrupt that signals a frame being finished. Indeed, grepping our FTrace log shows that <code>rkisp1_isr</code> is never called. A quick look at <code>/proc/interrupts</code> shows that '''the only interrupt associated with the isp has never triggered''' (0 count on every CPU):
<pre>
# head -n1 /proc/interrupts; grep isp /proc/interrupts
CPU0 CPU1 CPU2 CPU3 CPU4 CPU5
57: 0 0 0 0 0 0 GICv3 75 Level ff914000.iommu, rkisp1
</pre>

=== <code>rkisp1</code> debugfs info ===

The <code>rkisp1</code> driver keeps some [https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers/media/platform/rockchip/rkisp1/rkisp1-common.h?h=linux-6.6.y#n418 error/debug counters] in debugfs, which can be viewed at <code>/sys/kernel/debug/ff910000.isp0</code>.

Sadly, the only one of these that comes up nonzero is <code>sp_stop_timeout</code> ("upon stream stop, the capture waits 1 second for the isr to stop the stream. This param is incremented in case of timeout"). I observe it to increment once per time I terminate the <code>"v4l2-ctl" ... "--stream-mmap"</code> command. This tells us what we already know: interrupts are not firing, but it also tells us that we aren't hitting any other errors that rkisp1 knows about.

== Next steps ==

Where do we go from here? I don't know--something may be wrong with the way the .dts specifies interrupts, some kind of firmware/GIC (the rk3399's interrupt controller) configuration issue, or something else. It would be good to try to determine:

* Whether the MIPI lines actually show traffic, if someone has a logic analyzer and a dissected PPP.
* Whether the DMA of frames to memory actually happens, regardless of (lack of) emission of the interrupt that tells us when said DMA finishes a frame.
* Whether the regulator messages we see during boot are actually significant. I don't know enough about the Linux regulator framework to say whether these being not-found means power is not correctly supplied, or if Linux just isn't being properly informed of the power supply requirements for precise tracking/power-saving when the camera is off.

== Megi saves the day ==

<pre>
[I] <megi> you might be interested in this https://megous.com/dl/tmp/0ae6ba03a17a3d53.png
[I] <megi> https://megous.com/git/linux/tag/?h=orange-pi-5.18-20220521-1759
</pre>

Turns out, the .dts had the wrong ISP connected to the sensor! This is fixed in [https://github.com/megous/linux/commit/9afd884f8b36121fb6097e77b6d35fe46ab48ad9 this commit], which is included in kernel version 5.18 or newer.

With a sufficiently new kernel, the following should produce an image (<code>frame.jpg</code>):

<pre>
"media-ctl" "-d" "platform:rkisp1" "-r"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"imx258 1-001a":0 [fmt:SGRBG10_1X10/1048x780]'
"media-ctl" "-d" "platform:rkisp1" "-l" "'imx258 1-001a':0 -> 'rkisp1_isp':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":0 [fmt:SGRBG10_1X10/1048x780 crop:(0,0)/1048x780]'
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":2 [fmt:YUYV8_2X8/1048x780 crop:(0,0)/1048x780]'
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1048,height=780,"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":0 [fmt:YUYV8_2X8/1048x780 crop:(0,0)/1048x780]'

"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1048,height=780,pixelformat=422P"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "1" "--stream-to=frame.raw"

ffmpeg -y -s:v 1048x780 -pix_fmt yuv422p -i frame.raw frame.jpg
</pre>

Similarly, you can take a photo from the front camera with the following:

<pre>
"media-ctl" "-d" "platform:rkisp1" "-r"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'m00_f_ov8858 1-0036':0 [fmt:SBGGR10_1X10/1632x1224]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'m00_f_ov8858 1-0036':0 -> 'rkisp1_isp':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_isp':0 [fmt:SBGGR10_1X10/1632x1224 crop:(0,0)/1632x1224]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_isp':2 [fmt:YUYV8_2X8/1632x1224 crop:(0,0)/1632x1224]"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1632,height=1224,"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_resizer_selfpath':0 [fmt:YUYV8_2X8/1632x1224 crop:(0,0)/1632x1224]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_resizer_selfpath':1 [fmt:YUYV8_2X8/1632x1224]"

"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1632,height=1224,pixelformat=422P"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "1" "--stream-to=frame.raw"

ffmpeg -y -s:v 1632x1224 -pix_fmt yuv422p -i frame.raw frame.jpg
</pre>

In some cases, the isp exposes 2 devices nodes, and the nodes have separate topologies with a different sensor attached to each. In this situation, you may need to reference the isp using the correct device node for the commands to work.

=== Newer (6.x) kernels ===

The <code>rkisp1</code> driver has changed significantly in more recent kernel versions, and the V4L2 node topology varies, often breaking the example commands shown here.

In particular, newly introduced CSI and resizer subdevices mean that a configuration similar to the following is required to make a 4208x3120 capture from the imx258 camera when running [https://codeberg.org/megi/linux/archive/orange-pi-6.9-20240512-2332.tar.gz Megi's 6.9 kernel]:

<pre>
media-ctl -d 1 -r
media-ctl -d 1 -l "'imx258 1-001a':0 -> 'rkisp1_csi':0 [1]"
media-ctl -d 1 -l "'rkisp1_csi':1 -> 'rkisp1_isp':0 [1]"
media-ctl -d 1 -l "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [0]"
media-ctl -d 1 -l "'rkisp1_isp':2 -> 'rkisp1_resizer_mainpath':0 [1]"
media-ctl -d 1 --set-v4l2 '"imx258 1-001a":0 [fmt:SRGGB10_1X10/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_isp":0 [fmt:SRGGB10_1X10/4208x3120 crop: (0,0)/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_isp":2 [fmt:YUYV8_2X8/4208x3120 crop: (0,0)/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_resizer_mainpath":0 [fmt:YUYV8_2X8/4208x3120 crop: (0,0)/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_resizer_mainpath":1 [fmt:YUYV8_2X8/4208x3120]'
v4l2-ctl -d 5 -v width=4208,height=3120,pixelformat=422P
v4l2-ctl -d 5 --stream-mmap --stream-count 1 --stream-to=/tmp/frame.raw
ffmpeg -y -s:v 4208x3120 -pix_fmt yuv422p -i /tmp/frame.raw /tmp/frame.jpeg
</pre>

=== What's left? ===

* libcamera and megapixels still don't work. Megapixels appears to need support for debayering YUYV, and both appear to be configuring the rkisp1 pipeline wrong.
* The images captured are pretty green and seem to have two pixels of garbage at their bottom edge. rkisp1 supports auto white-balance (AWB) using the params/stats pads, and libcamera has some smarts that may hook these up properly. In the meantime, raw images can be postprocessed to improve white balance and exposure.

== Useful links ==

* [https://files.pine64.org/doc/PinePhonePro/PinephonePro-Schematic-V1.0-20211127.pdf Pinephone Pro Schematic]
* [https://blog.krybot.com/a?ID=01650-cea27a80-a1ab-4da1-9cb5-3945be91e3e1 Background on the GIC]
* [https://elinux.org/images/9/94/ISP-presentation.pdf Background on the rkisp1 ISP]

[[Category:PinePhone Pro]]

PinePhone Pro/IMX258 Camera Debugging

2024-11-10T14:42:45Z

Diederik: Update various links to (current) latest upstream LTS kernel (6.6)

{{Under construction}}

== Background ==

The Pinephone Pro's rear camera is a Sony IMX258. The camera driver is present upstream, and at least [https://gitlab.manjaro.org/manjaro-arm/packages/core/linux-pinephonepro Manjaro's kernel] (downstream of Megi's) enables the driver. The camera does not seem to work; this page catalogs work on figuring out why.

== Initial status ==

What do we see in dmesg?

<pre>
imx258 1-001a: supply vana not found, using dummy regulator
imx258 1-001a: supply vdig not found, using dummy regulator
</pre>

This tells us the kernel loads the driver, which is something.

Are these errors bad/fatal? Inspecting the [https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers/media/i2c/imx258.c?h=linux-6.6.y source] shows us that these supplies are defined in the <code>imx258_supply_names</code> array, and <code>imx258_probe</code> calls <code>devm_regulator_bulk_get</code> to set them up.
<code>imx258_probe</code> checks the return code from <code>devm_regulator_bulk_get</code>, emitting a fatal "Failed to get supplies" message if the return code is negative (indicating failure). Since we don't see this message (or any others from the driver), it looks like it loads successfully!

=== How can we test the camera? ===

==== Megapixels ====

[https://gitlab.com/postmarketOS/megapixels Megapixels] requires a per-device file to configure cameras. This one isn't complete (most of its numbers are complete nonsense), but it should let us see what happens when Megapixels tries to access the camera:
<code>pine64,pinephone-pro.ini</code>:
<pre>
[device]
make=PINE64
model=PinePhone Pro

[rear]
driver=imx258
media-driver=rkisp1
capture-width=4208
capture-height=3118
capture-rate=60
capture-fmt=GRBG10P
preview-width=1280
preview-height=960
preview-rate=60
#preview-fmt=BGGR8
capture-fmt=GRBG10P
rotate=90
mirrored=true
focallength=2.6
cropfactor=12.7
fnumber=2.8
flash-display=true
</pre>

This segfaulted Megapixels for me. After patching some trivial segfaults, I get fatal GTK4 issues and other tangential problems. Let's try something else.

==== Manually setting up a camera pipeline ====

We can roughly follow [https://www.kernel.org/doc/html/latest/admin-guide/media/rkisp1.html this guide]. Doing so gives us the following commands:
<pre>
"media-ctl" "-d" "platform:rkisp1" "-r"
"media-ctl" "-d" "platform:rkisp1" "-l" "'imx258 1-001a':0 -> 'rkisp1_isp':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":0 [fmt:SGRBG10_1X10/1048x780]'
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1048,height=780,"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":0 [fmt:SGRBG10_1X10/1048x780 crop:(0,0)/1048x780]'

"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=800,height=600,pixelformat=422P"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "1" "--verbose"
</pre>

Careful readers will note that this is setting the camera up with a low resolution compared to what the sensor can do. For some reason I can't get the rkisp1 node to configure its sink pad with the maximum resolution of the sensor (4208x3118). Instead, it sets itself to 4032x3024. This mismatch is forbidden and causes v4l2 to give us EPIPE when we try to enable the stream. Using the lower resolution gets us further--the last command (which attempts to save a single frame of video) gives output like this:
<pre>
VIDIOC_QUERYCAP: ok
VIDIOC_REQBUFS returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QUERYBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_QBUF returned 0 (Success)
VIDIOC_STREAMON returned 0 (Success)
</pre>

But then it just hangs there indefinitely.

Running under strace, we see the program stuck in an ioctl:
<pre>
ioctl(3, VIDIOC_DQBUF, {type=V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE
</pre>

[https://www.kernel.org/doc/html/v6.6/userspace-api/media/v4l/vidioc-qbuf.html VIDIOC_DQBUF] corresponds to dequeuing a buffer once it has been filled with an image by the v4l2 device. Apparently, the device never gives us back a captured frame.

=== Now what? ===

==== Does i2c work at all? ====

The camera driver uses i2c; we can see the camera [https://github.com/megous/linux/blob/c5af9f4f874a66b65c73c450b79f6a86b1b46332/arch/arm64/boot/dts/rockchip/rk3399-pinephone-pro.dts#L890-L914 in the .dts] to determine that it's on i2c bus 1, address 0x1a.

The imx258 is controlled over i2c, and sends image data over MIPI. The first step is to see if the i2c control is working.

Looking back at the driver, it seems we should see errors in dmesg if i2c communication fails. The driver checks the chip id in its probe function, which uses i2c, so we can conclude that i2c gets set up properly initially. Does it keep working?

==== Does i2c keep working? (FTrace) ====

We can see if other functions that use i2c produce errors--for example, when we run our <code>"v4l2-ctl" ... "--stream-mmap"</code> command, we expect that <code>imx258_start_streaming</code> will get called, and this function also writes a load of registers over i2c.

Build and install a kernel with CONFIG_FTRACE (not hard, but outside the scope of this write-up) and enable function graph tracing:
<pre>
$ sudo su
# cd /sys/kernel/debug/tracing
# echo function_graph > current_tracer
# cat available_filter_functions | grep -E 'rkisp|imx258|v4l2' | awk '{print $1}' > set_graph_function
# echo 'vm_map_pages,__iommu_map,iommu_map_sg_atomic,rk_iommu_map,__alloc_pages,dma_alloc_attrs,dma_mmap_attrs,__vm_map_pages,vb2_mmap,clk_e,able,schedule_timeout,clk_disable,regmap_write,schedule,__i2c_tra,sfer,i2c_tra,sfer_buffer_flags,dma_free_attrs' | tr , '\n' > set_graph_notrace
# tee trace_pipe > ~/function-trace.log
</pre>

Now, in another terminal session, run the <code>"v4l2-ctl" ... "--stream-mmap"</code> command again. We end up with a bunch (but hopefully not *too* much) of output in our first terminal and the <code>~/function-trace.log</code> file.

A quick grep shows that <code>imx258_start_streaming</code> is indeed called, so '''i2c is working properly'''.

=== If i2c works, what doesn't? ===

Our program that asks for a video frame is still hung! We ask the camera to start streaming frames, it presumably does, but the v4l2 stack never tells us a frame has finished. Doing some digging in the v4l2 stack (and the rkisp1 driver), we find out that rkisp1 is notified about frame status via interrupts. We figure this out by manually backtracking through the code to see when <code>vb2_buffer_done</code>, the function in the vb2 API to call when a frame is finished, would be called. In the rkisp1 code, <code>vb2_buffer_done</code> is only called from <code>rkisp1_handle_buffer</code> which is only called from <code>rkisp1_capture_isr</code>, which (for the PPP's rk3399 SoC) is only called from <code>rkisp1_isr</code>, which is an interrupt handler. We know that it's an interrupt handler from the name (<code>_isr</code>), but also because it gets passed (indirectly) to <code>devm_request_irq</code> by way of being the <code>.isr</code> field of <code>rk3399_isp_isrs</code>.

Perhaps the hardware is never actually emitting the interrupt that signals a frame being finished. Indeed, grepping our FTrace log shows that <code>rkisp1_isr</code> is never called. A quick look at <code>/proc/interrupts</code> shows that '''the only interrupt associated with the isp has never triggered''' (0 count on every CPU):
<pre>
# head -n1 /proc/interrupts; grep isp /proc/interrupts
CPU0 CPU1 CPU2 CPU3 CPU4 CPU5
57: 0 0 0 0 0 0 GICv3 75 Level ff914000.iommu, rkisp1
</pre>

=== <code>rkisp1</code> debugfs info ===

The <code>rkisp1</code> driver keeps some [https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers/media/platform/rockchip/rkisp1/rkisp1-common.h?h=linux-6.6.y#n418 error/debug counters] in debugfs, which can be viewed at <code>/sys/kernel/debug/ff910000.isp0</code>.

Sadly, the only one of these that comes up nonzero is <code>sp_stop_timeout</code> ("upon stream stop, the capture waits 1 second for the isr to stop the stream. This param is incremented in case of timeout"). I observe it to increment once per time I terminate the <code>"v4l2-ctl" ... "--stream-mmap"</code> command. This tells us what we already know: interrupts are not firing, but it also tells us that we aren't hitting any other errors that rkisp1 knows about.

== Next steps ==

Where do we go from here? I don't know--something may be wrong with the way the .dts specifies interrupts, some kind of firmware/GIC (the rk3399's interrupt controller) configuration issue, or something else. It would be good to try to determine:

* Whether the MIPI lines actually show traffic, if someone has a logic analyzer and a dissected PPP.
* Whether the DMA of frames to memory actually happens, regardless of (lack of) emission of the interrupt that tells us when said DMA finishes a frame.
* Whether the regulator messages we see during boot are actually significant. I don't know enough about the Linux regulator framework to say whether these being not-found means power is not correctly supplied, or if Linux just isn't being properly informed of the power supply requirements for precise tracking/power-saving when the camera is off.

== Megi saves the day ==

<pre>
[I] <megi> you might be interested in this https://megous.com/dl/tmp/0ae6ba03a17a3d53.png
[I] <megi> https://megous.com/git/linux/tag/?h=orange-pi-5.18-20220521-1759
</pre>

Turns out, the .dts had the wrong ISP connected to the sensor! This is fixed in [https://github.com/megous/linux/commit/9afd884f8b36121fb6097e77b6d35fe46ab48ad9 this commit], which is included in kernel version 5.18 or newer.

With a sufficiently new kernel, the following should produce an image (<code>frame.jpg</code>):

<pre>
"media-ctl" "-d" "platform:rkisp1" "-r"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"imx258 1-001a":0 [fmt:SGRBG10_1X10/1048x780]'
"media-ctl" "-d" "platform:rkisp1" "-l" "'imx258 1-001a':0 -> 'rkisp1_isp':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":0 [fmt:SGRBG10_1X10/1048x780 crop:(0,0)/1048x780]'
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":2 [fmt:YUYV8_2X8/1048x780 crop:(0,0)/1048x780]'
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1048,height=780,"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":0 [fmt:YUYV8_2X8/1048x780 crop:(0,0)/1048x780]'

"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1048,height=780,pixelformat=422P"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "1" "--stream-to=frame.raw"

ffmpeg -y -s:v 1048x780 -pix_fmt yuv422p -i frame.raw frame.jpg
</pre>

Similarly, you can take a photo from the front camera with the following:

<pre>
"media-ctl" "-d" "platform:rkisp1" "-r"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'m00_f_ov8858 1-0036':0 [fmt:SBGGR10_1X10/1632x1224]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'m00_f_ov8858 1-0036':0 -> 'rkisp1_isp':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_isp':0 [fmt:SBGGR10_1X10/1632x1224 crop:(0,0)/1632x1224]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_isp':2 [fmt:YUYV8_2X8/1632x1224 crop:(0,0)/1632x1224]"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1632,height=1224,"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_resizer_selfpath':0 [fmt:YUYV8_2X8/1632x1224 crop:(0,0)/1632x1224]"
"media-ctl" "-d" "platform:rkisp1" "--set-v4l2" "'rkisp1_resizer_selfpath':1 [fmt:YUYV8_2X8/1632x1224]"

"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=1632,height=1224,pixelformat=422P"
"v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "1" "--stream-to=frame.raw"

ffmpeg -y -s:v 1632x1224 -pix_fmt yuv422p -i frame.raw frame.jpg
</pre>

In some cases, the isp exposes 2 devices nodes, and the nodes have separate topologies with a different sensor attached to each. In this situation, you may need to reference the isp using the correct device node for the commands to work.

=== Newer (6.x) kernels ===

The <code>rkisp1</code> driver has changed significantly in more recent kernel versions, and the V4L2 node topology varies, often breaking the example commands shown here.

In particular, newly introduced CSI and resizer subdevices mean that a configuration similar to the following is required to make a 4208x3120 capture from the imx258 camera when running [https://codeberg.org/megi/linux/archive/orange-pi-6.9-20240512-2332.tar.gz Megi's 6.9 kernel]:

<pre>
media-ctl -d 1 -r
media-ctl -d 1 -l "'imx258 1-001a':0 -> 'rkisp1_csi':0 [1]"
media-ctl -d 1 -l "'rkisp1_csi':1 -> 'rkisp1_isp':0 [1]"
media-ctl -d 1 -l "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [0]"
media-ctl -d 1 -l "'rkisp1_isp':2 -> 'rkisp1_resizer_mainpath':0 [1]"
media-ctl -d 1 --set-v4l2 '"imx258 1-001a":0 [fmt:SRGGB10_1X10/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_isp":0 [fmt:SRGGB10_1X10/4208x3120 crop: (0,0)/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_isp":2 [fmt:YUYV8_2X8/4208x3120 crop: (0,0)/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_resizer_mainpath":0 [fmt:YUYV8_2X8/4208x3120 crop: (0,0)/4208x3120]'
media-ctl -d 1 --set-v4l2 '"rkisp1_resizer_mainpath":1 [fmt:YUYV8_2X8/4208x3120]'
v4l2-ctl -d 5 -v width=4208,height=3120,pixelformat=422P
v4l2-ctl -d 5 --stream-mmap --stream-count 1 --stream-to=/tmp/frame.raw
ffmpeg -y -s:v 4208x3120 -pix_fmt yuv422p -i /tmp/frame.raw /tmp/frame.jpeg
</pre>

=== What's left? ===

* libcamera and megapixels still don't work. Megapixels appears to need support for debayering YUYV, and both appear to be configuring the rkisp1 pipeline wrong.
* The images captured are pretty green and seem to have two pixels of garbage at their bottom edge. rkisp1 supports auto white-balance (AWB) using the params/stats pads, and libcamera has some smarts that may hook these up properly. In the meantime, raw images can be postprocessed to improve white balance and exposure.

== Useful links ==

* [https://files.pine64.org/doc/PinePhonePro/PinephonePro-Schematic-V1.0-20211127.pdf Pinephone Pro Schematic]
* [https://blog.krybot.com/a?ID=01650-cea27a80-a1ab-4da1-9cb5-3945be91e3e1 Background on the GIC]
* [https://elinux.org/images/9/94/ISP-presentation.pdf Background on the rkisp1 ISP]

[[Category:PinePhone Pro]]

ROCKPro64 Software Releases

2023-11-28T12:45:30Z

Diederik: Debian: Recommend Bookworm as that's the current Stable

This page contains a list of all available releases and tools for the [[ROCKPro64]] in alphabetical order.

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

'''AOSC OS''' is a general purpose Linux distribution that strives to simplify user experience and improve free and open source software for day-to-day productivity. Originally AnthonOS (an OpenSUSE derivative built with SUSE Studio), then remade as a Debian derivative with customized KDE 4 UI and CJK support. To learn more about AOSC, please visit the official [https://aosc.io/ AOSC website]

Download:
* https://aosc.io/downloads/ (supports the microSD card and eMMC, 8GB or more)

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

----

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

'''Armbian''' is a Linux distribution designed for ARM boards. They are usually Debian or Ubuntu flavored. To find out more about Armbian and available options please visit their [https://www.armbian.com/rockpro64/ site]. If you are booting from a Micro SD card, then both Linux kernel versions will work. If you are trying to boot from an eMMC module then the 4.4.y will work, but the newer 5.10.y will not.

Download:
* https://dl.armbian.com/rockpro64/archive/

----

=== Batocera Linux ===
[[File:batocera.png|right|100px]]

'''Batocera Linux''' is an open-source and completely free retro-gaming distribution that can be copied to a USB stick or an SD card with the aim of turning any computer/nano computer into a gaming console during a game or permanently. Visit the project's website here (https://batocera.org/). You can follow the ongoing discussion about batocera.linux on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=7084)

Download:
* https://batocera.org/download

----

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

'''Debian''' is an operating system and a distribution of free software. See the forum thread [https://forum.pine64.org/showthread.php?tid=9744 here].

Download:
* [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ Debian 11 Bullseye]
* [https://deb.debian.org/debian/dists/bookworm/main/installer-arm64/current/images/netboot/SD-card-images/ Debian 12 Bookworm] (recommended)
* [https://d-i.debian.org/daily-images/arm64/ Daily netboot images]

Instructions:
* Download: <code>firmware.rockpro64-rk3399.img.gz</code>
* Download: <code>partition.img.gz</code>
* Create the disk image:
** For Linux: <code>zcat firmware.rockpro64-rk3399.img.gz partition.img.gz > complete_image.img</code>
** For Mac: <code>gzcat firmware.rockpro64-rk3399.img.gz partition.img.gz > complete_image.img</code>
* Write the image to your boot device:
** For Linux: <code>dd if=complete_image.img of=your_chosen_boot_device bs=4M</code>
** For Mac: see [[Getting started]]

Notes:
* An Ethernet connection is required for the above installer
* Remember to leave some space before your first partition for u-boot! You can do this by creating a 32M size unused partition at the start of the device.
* See the [[ROCKPro64#No_Video_or_GPU_Acceleration_on_Debian|troubleshooting section]] if you encounter issues with GPU acceleration.

----

=== 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 ROCKPro64 build on the [https://forum.pine64.org/showthread.php?tid=12532 PINE64 forum thread].

Download:
* [https://dietpi.com/downloads/images/DietPi_ROCKPro64-ARMv8-Bookworm.img.xz Direct download from dietpi.com]

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

----

=== LibreELEC ===
[[File:libreelec.jpg|right|100px]]
'''LibreELEC''' is a lightweight 'Just enough OS' Linux distribution purpose-built for Kodi on current and popular mediacentre hardware.

Download:
* [https://libreelec.tv/downloads/rockchip/ Official LibreELEC build image] (look for PINE64 RockPro64-LibreELEC-RK3399.arm-x.x.x-rockpro64.img.gz, supports microSD card and the eMMC module of 8GB or more.)

{{Info|Unzip and flash the image to a microSD card or eMMC module, for example using ''dd''.}}

----

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

'''Manjaro''' is a user-friendly Linux distribution based on the independently developed Arch operating system. To learn more about Manjaro please visit [https://forum.manjaro.org/c/arm/releases/102 Manjaro forum].

Download:
* [https://github.com/manjaro-arm/rockpro64-images/releases from Github]

Notes:
* Decompress the image (<tt>unxz</tt>) before flashing, or decompress on the fly while flashing (<tt>xzcat</tt> in a root shell, Etcher, ...)
* A display and keyboard will be required for first boot.
* Initial setup includes: keyboard layout, locale, username, user password, and root password.
* The installer will expand the root partition to use the remaining space on the storage device you've flashed.

----

=== Nems Linux ===
[[File:nems.jpg|right|100px]]

'''NEMS''' stands for ''Nagios Enterprise Monitoring Server'' and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers. To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread].

Download:
* [https://nemslinux.com/download/nagios-for-pine64.php Download page] with torrent seed or direct download.

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

----

=== NixOS ===
[[File:NixOS.webp|right|100px]]

'''NixOS''' is a Linux distribution built on top of the Nix package manager using declarative configuration to allow reliable system upgrades. More information can be found on the [https://nixos.wiki/wiki/NixOS_on_ARM/PINE64_ROCKPro64 NixOS wiki].

Download:
* [https://github.com/AshyIsMe/nixos-installer-rockpro64 nixos-installer-rockpro64]

----

=== OpenMediaVault ===
[[File:omv.png|right|100px]]

'''OpenMediaVault''' is the next generation network attached storage (NAS) solution, [https://www.openmediavault.org/ click this link to OMV main page] to learn more. Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6308 here]

Download:
{{Outdated release}}
* Stretch 32bit (armhf): [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
* Stretch 64bit (aarch64): [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]

Notes:
* You need to enable root login in OMV WebGUI
* [http://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! TTY and SSH, except OMV
| <code>rock64/rock64</code>
|-
! WebGUI Login
| <code>admin/openmediavault</code>
|-
! TTY and SSH
| <code>root/openmediavault</code>
|}

----

=== OpenWrt ===
[[File:Openwrt logo square.png|right|100px]]

'''OpenWrt''' is a highly extensible GNU/Linux distribution for embedded devices (typically wireless routers). Unlike many other distributions for these routers, OpenWrt is built from the ground up to be a full-featured, easily modifiable operating system for your router. In practice, this means that you can have all the features you need with none of the bloat, powered by a Linux kernel that's more recent than most other distributions.

Download:
* https://openwrt.org/toh/pine64/rockpro64_v2.1

----

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

postmarketOS extends [https://www.alpinelinux.org/ Alpine Linux] to run on smartphones and other devices.
At the time of writing, the only user interface provided through prebuilt images for the ROCKPro64 is [https://plasma-bigscreen.org/ Plasma Bigscreen].

Download:
* https://postmarketos.org/download/

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

----

=== R-Cade ===
[[File:RCadeLogo.jpg|right|100px]]

Retro Center's '''R-Cade''', the 4K Media Center Arcade. [https://www.retro-center.com/about-r-cade/ RCade] Features 100+ retro-gaming systems, a lightweight web browser, and full 4K UHD media playback.

Download:
* [https://github.com/retro-center/rcade_releases/releases Direct download from Retro Center's GitHub] (USB, microSD and eMMC boot)

----

=== Recalbox ===
[[File:RB.png|right|100px]]

'''Recalbox''' allows you to re-play a variety of videogame consoles and platforms in your living room, with ease! Visit the project's website here (https://www.recalbox.com/). You can follow the ongoing discussion about Recalbox on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=7194)

Download:
{{Template:Outdated release}}
* [https://github.com/mrfixit2001/recalbox_rockpro64/releases download] release from mrfixit2001 github.

----

=== Retro Arena ===
[[File:retroarena.png|right|100px]]

'''Retro Arena''' community build for microSD and eMMC boot. This is a BETA and therefore is not update-able nor supported, however bugs or issues are appreciated to be identified and shared via the issues tab on our GitHub so that we can address them in the future. The Roshambo Case support is baked in with one major caveat due to kernel limitation: You can power the unit off by the POWER switch and the RESET button works 100% however to power the unit on you will need to manually plug/unplug the power cord. This limitation will not be present in future releases. You can follow the ongoing discussion about Retro Arena on the [https://forum.pine64.org/showthread.php?tid=7555 forum]

Download:
{{Outdated release}}
* [http://files.pine64.org/os/ROCKPro64/odroidretroarena/TheRA-RP64-BETA-0.8-FINAL.img.gz Direct download from pine64.org]

----

=== SkiffOS ===
[[File:SkiffOS-Icon-1.png|right|100px]]
Minimal cross-compiled OS optimized for hosting distributions in Docker containers. Provides the reliability of firmware with the ease-of-use of package managers. Uses the [http://buildroot.org Buildroot] cross-compilation tool for support for all Pine64 boards.

Use configuration packages to configure the distribution:
* core/gentoo: Gentoo optimized for Rockpro64
* core/nixos: NixOS arm64

You can also configure the skiff core yaml file to configure multiple distributions to run in parallel.

The boot-up OS can be upgraded independently from the containers.

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

----

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

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

Resources:
* [https://docs.slackware.com/slackwarearm:inst Installation instructions].
* [https://www.youtube.com/watch?v=uXAL9jz-yaA&list=PL1XOSJnvang3VLmqke2QbRitKtOD6Rm3t Installation video guide]

----

=== slarm64 ===

'''slarm64''' is an unofficial aarch64 / riscv64 Slackware Linux port. You can follow the ongoing discussion about slarm64 on the RockPro64 on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=6823) or this forum thread for more general slarm64 information: https://www.linuxquestions.org/questions/slackware-arm-108/slarm64-aarch64-unofficial-slackware-4175613287/.

Downloads:
* [http://dl.fail.pp.ua/slackware/images/rockpro64/ download] (supports microSD card, look for slarm64-current-aarch64-xfce-rockpro64-x.xx.x-build-xxxxxxxx.img.zst)

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

Flashing the distribution to the eMMC:
* Flash the image to micro SD, power up the board with micro SD and login
* Copy the image file to micro SD by using SFTP. The image file must have the ''.img'' file extension.
* After finish copy the file, power off the board and add eMMC module to the board
* Boot the board, run below command for flashing to eMMC module
* Run <code>dd if=[image file] of=/dev/mmcblkX bs=10M</code> (example: ''sudo dd if=slack-current-aarch64-xfce_29Sep18-4.4.162-rockpro64-build-20181126.img of=/dev/mmcblkX bs=10M'')
* then edit these two files in eMMC module:
** <code>mount /dev/mmcblk1p1 /media</code>
** <code>echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt</code>
** <code>sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab</code>
* After that, power off the board and remove the microSD card. Then boot with only the eMMC module.

----

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

'''Twister OS''' brings a desktop computing experience for SBCs, right out-of-the-box. Including themes, applications, tools, and optimizations to get the most out of your SBC. For more information on Twister OS, please visit the [https://twisteros.com/ official site]. You can follow the ongoing discussion about Twister OS on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=12192).

Download:
* [https://twisteros.com/twisterarmbian.html Twister OS Armbian-Reforged XFCE Desktop image] (2.8GB, supports the microSD card and eMMC modules with 16GB and more)

{{Info|After flashing image with Etcher, edit /boot/armbianEnv.txt, replace the dtb name with rk3399-rockpro64.dtb.}}

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

----

=== Void Linux ===
'''Void Linux''' is a general purpose operating system, based on the monolithic Linux kernel. The official guide can be found at [https://docs.voidlinux.org/installation/guides/arm-devices/index.html Guide]. At this time there are no RockPro64 images available.

The following creates a bootable image from an existing Void Linux installation:
* <code>xbps-insall -Syu</code> to update the xbps installation of the installation
* create ROCKPro64 image with the ''void-mklive'' software (from github.com):
** create a rootfs via ''mkrootfs.sh'': <code>sh mkrootfs.sh -o void-aarch64-muls-ROOTFS-yyyymmdd.tar.xz</code>
** <code>sh mkplatformfs.sh rockpro64 void-aarch64-muls-ROOTFS-yyyymmdd.tar.xz</code>
** <code>sh mkimage.sh -s 7GiB void-rockpro64-PLATFORMFS-yyyymmdd.tar.xz</code>
* write image to sdcard or eMMC: <code>dd if='''IMAGE-FILENAME''' of='''DEVICENAME''' bs=2M</code>
* If ''mkplatformfs.sh'' errors with ''ROCKPro64 not supported'', install ''xbps-src'' from https://github.com/void-linux/void-packages and build the ROCKPro64 package.
* Tip: write a new U-Boot to the image if you see on the serial console the boot-up stalls:
** get the two U-Boot files from [https://pkgs.org/download/u-boot-rockpro64 pkgs.org], the aarch64 files:
** <code>dd if=idbloader.img of=DEVICENAME seek=64</code>
** <code>dd if=u-boot.itb of=DEVICENAME seek=16384</code>

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

== BSD Images ==
=== FreeBSD ===
[[File:Freebsd_Logo.png|right|100px]]

'''FreeBSD''' is an operating system used to power modern servers, desktops, and embedded platforms. The [https://wiki.freebsd.org/arm/RockChip#RockPro64 RockChip FreeBSD page] has instructions for installing FreeBSD. Version 13.0 and greater include prebuilt images.

Download:
* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! SSH user (enabled by default)
| <code>freebsd/freebsd</code>
|-
! Root user
| <code>root/root</code>
|}

Notes:

* The wiki has instructions on [https://wiki.freebsd.org/arm/RockChip#Fan_Control_on_RockPro64 enabling the PWM cooling fan].

----

=== NetBSD ===
[[File:netbsd.png|right|100px]]
'''NetBSD''' is a free, fast, secure, and highly portable Unix-like Open Source operating system. To learn more about NetBSD please visit [https://www.netbsd.org/ NetBSD main page]

Download:
* [https://armbsd.org/ download] latest release build from NetBSD by select 64bit - RockPro64 (size: 339 MB)

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Root user and SSH login
| <code>root/[none]</code>
|}

Notes:
* Instructions concerning enabling SSH can be found [https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-ssh here] or the bootable image from armbsd.org can have the MSDOS partition modified to setup SSH using [https://man.netbsd.org/creds_msdos.8 this] method.

----

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

'''OpenBSD''' is a security-focused, free and open-source, Unix-like operating system based on the Berkeley Software Distribution. Official instruction to get OpenBSD on ROCKPro64 is [https://www.openbsd.org/arm64.html here], and blogs on installation [https://github.com/jasperla/openbsd-rockpro64 is here] and [https://bsandro.tech/posts/openbsd-7.1-on-pine64-rockpro64/ here]. Forum discussion is [https://forum.pine64.org/forumdisplay.php?fid=109 here].

== Chromium OS ==
[[File:chromium.jpg|right|100px]]

The '''Chromium OS''' community build image for microSD card and eMMC module, version beta (R76). To learn more please visit the [https://forum.pine64.org/showthread.php?tid=7659 forum].

Download:
{{Outdated release}}
* https://github.com/ayufan-rock64/chromiumos-build/releases/

{{Info|Flash the image to a microSD card or an eMMC module, for example using ''dd''.}}

== Android ==
[[File:Android_logo_2019_(stacked).svg|right|100px]]

=== Android 9.0.0 ===

'''Stock for DD method [eMMC Boot] [20200804]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Supports new RockPro64 AP6256 Wifi/BT module
* Support Sony IMX214 camera module and works on both MiPi-CSI ports
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 8GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 7287fd0846616354615c8d3eff6a2a92
*** File Size: 602MB
* DD image for 16GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 78352bbf21198d062af8bab2217ee691
*** File Size: 611MB
* DD image for 32GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): c5c8dce419478f75f85f893ee4808dbd
*** File Size: 624MB
* DD image for 64GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): aab1cf4d30c4d16e6ce2672f3ecae935
*** File Size: 666MB

'''Stock for RK Flash tool [eMMC Boot] [20200804]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20200708_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): 9ac830527814521e15b009fa2503c9e3
** File Size: 589MB

'''Stock for DD method [eMMC Boot] [20200708]
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Supports new RockPro64 AP6256 Wifi/BT module
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 8GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): ef5f5a890a9270734e0adee21f006837
*** File Size: 597MB
* DD image for 16GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 179bd684a468f800a86f7c658a543bef
*** File Size: 606MB
* DD image for 32GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): d930b757c4427be07b83c37a9c8494a1
*** File Size: 630MB
* DD image for 64GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09a970d68a10bdb3d6495d55860940e6
*** File Size: 660MB

'''Stock for RK Flash tool [eMMC Boot] [20200708]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20200708_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): 6d060ddd47ebcfd5cfcdbf90ec042c97
** File Size: 589MB

'''Stock for DD method [eMMC Boot] [20190427]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Please ignore "internal problem with your device" popup message if appear on Android boot-up page.
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 16GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190417_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 3BA4C72D81BCFC4C21B3B5D2BCB4F9F7
*** File Size: 609MB
* DD image for 32GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190417_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4965CCF50A8F06CEB2E4A6828A21F31C
*** File Size: 627MB
* DD image for 64GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190417_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 748EC28FE5D5395D33E858C913D744BF
*** File Size: 663MB

'''Stock for DD method [microSD Boot] [20190506]'''
* DD image to microSD card and boot.
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Please ignore "internal problem with your device" popup message if appear on Android boot-up page.
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 8GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): E1C551E8106E178841E1C3F71432194A
*** File Size: 599MB
* DD image for 16GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 73592FDD5A2F52F08020F16AD99E8C8C
*** File Size: 609MB
* DD image for 32GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 74DE0FE528F210E4DD483B411A71904B
*** File Size: 627MB
* DD image for 64GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D7626BD50443A88AEB9254C88C575284
*** File Size: 663MB

'''Stock for RK Flash tool [eMMC Boot] [20190427]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20190417_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): 046BA4A07933120809FBE1B9577B7341
** File Size: 592MB

----

=== Android 8.1.0 ===
'''Stock for DD method [eMMC Boot] [20180828]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20180828_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 9AEE21BC1B9DE886DCB0E64FA123988A
** File Size: 414MB

'''Stock for DD method [microSD Boot] [20181212]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image (for 8GB microSD card and above)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20181212_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 5A6BB7FCD7B3F77FCEE99CE462AE7405
** File Size: 616MB

'''Stock for RK Flash tool [eMMC Boot] [20180828]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180828_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 4DACFE927BB09EE9C56B5232A7F624EE
** File Size: 415MB

----

=== Android 7.1.2 ===
'''Stock for DD method [eMMC Boot] [20180809]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20180809_stock_android_7.1_emmcboot.img.gz Direct download from pine64.org]
** MD5 (XZ file): 00F194017557017C2588724686E90CEA
** File Size: 498MB

'''Stock for RK Flash tool [eMMC Boot] [20180809]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180809_stock_android_7.1_emmcboot.img.gz Direct download from pine64.org]
** MD5 (XZ file): 197A9905B48441D8655E7542F4643FE9
** File Size: 483MB

'''Stock for DD method [microSD Boot] [20180920]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180920_stock_android_7.1_sdboot.img.gz Direct download from pine64.org]
** MD5 (XZ file): CE39642A379B357BB3E4BC80ACA2E0CE
** File Size: 765MB

'''Stock for DD method [eMMC Boot] [20180518]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20180518_stock_android_7.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 33622034ACDBC31A7D7BB01ED634E29B
** File Size: 345MB

'''Stock for RK Flash tool [eMMC Boot] [20180518]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180518_stock_android_7.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 90C1991DADAE13ADC94E927F171F8920
** File Size: 342MB

'''Stock for install from SDcard to eMMC [microSD Boot] [20180921]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180921_stock_android_7.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): c6900e82a1d6ef397dcac241f76f43c9
** File Size: 350MB

----

=== Android SDK ===
'''Android P SDK [v9.0]'''
* [http://files.pine64.org/SDK/ROCKPro64/ROCKPro64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 3CEBEEFD1A873BEEEC149148A785D92E
** File Size: 125.16GB

----

=== Slash TV OS ===
Android 7 based system including Play Store, working only from SD card (does not boot when installed on eMMC)
* https://drive.google.com/drive/folders/1K5YhWaB7Xstuv2HCo1HkpglCEm9x-RIM

== Development resources ==

The Ayufan github page
* [https://github.com/ayufan-rock64/linux-build/releases github.com/ayufan-rock64/linux-build/]

Below are the LPDDR4 driver for RK3399

* [http://files.pine64.org/os/ROCKPro64/driver/rk3399_loader_v1.10.112_support_1CS.bin rk3399_loader_v1.10.112_support_1CS.bin, this is 800Mhz version used in Android Build]
* [http://files.pine64.org/os/ROCKPro64/driver/rk3399_ddr_666MHz_v1.11.bin rk3399_ddr_666MHz_v1.11.bin, this is alpha version]
* [http://files.pine64.org/os/ROCKPro64/driver/rk3399_ddr_933MHz_v1.11.bin rk3399_ddr_933MHz_v1.11.bin, this is alpha version]

ROCKPro64 related files

* [http://files.pine64.org/os/ROCKPro64/driver/kernel_rockpro64.tar.gz ROCKPro64 Kernel file]
* [http://files.pine64.org/os/ROCKPro64/driver/trust.img trust.img]

== Miscellaneous tools ==

* [http://files.pine64.org/doc/rock64/tools/DriverAssitant_v4.5.zip Windows ADB driver package]
* [[ROCK64 MAC Address]]
* [http://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]
* [http://files.pine64.org/doc/rock64/tools/SD_Firmware_Tool._v1.46.zip Tools to burn Android build into a bootable microSD card]
* [http://files.pine64.org/doc/rock64/tools/AndroidTool_Release_v2.38.zip Tools that allows developer flash image into eMMC's Loader/Parameter/Misc/Kernal/Boot/Recovery/System/Backup partition]

[[Category:ROCKPro64]]

Quartz64 Development

2023-08-22T15:02:52Z

Diederik: /* Upstreaming Status */ RGA is mainlined in 6.5, but there are some 'issues'

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], 4k@30 support and other improvements in 6.4-rc1[https://git.kernel.org/linus/83b61f817f43ed67572d1e241c9f552e0a8bfff4]
|-
| 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:LightYellow; text-align:center;"|Linux Mainline; Could be improved
| <code>rockchip-rga</code>
| As of 6.5[https://git.kernel.org/linus/0c3391f8bb06b744df521651534cd99e3d77e0a8]. Note that there's still a '4GB' problem and it's implementations has room for improvements (to put it midly [https://lore.kernel.org/all/20230522102953.GB23678@pengutronix.de/] and [https://lore.kernel.org/all/b404dc20-c460-ac3f-6659-8be7a7d32bfe@arm.com/])
|-
! 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&archive=both]
| <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/]

=== 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-08-17T23:04:43Z

Diederik: /* Upstreaming Status */ TRNG patch is now archived

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], 4k@30 support and other improvements in 6.4-rc1[https://git.kernel.org/linus/83b61f817f43ed67572d1e241c9f552e0a8bfff4]
|-
| 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&archive=both]
| <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/]

=== 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-08-17T22:46:52Z

Diederik: /* Upstreaming Status */ 4k@30 and other improvements since 6.4-rc1

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], 4k@30 support and other improvements in 6.4-rc1[https://git.kernel.org/linus/83b61f817f43ed67572d1e241c9f552e0a8bfff4]
|-
| 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/]

=== 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-08-17T22:43:21Z

Diederik: /* Partially Working */ No longer consider Video Output buggy or Partially working

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

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

PineTab2

2023-08-01T14:34:10Z

Diederik: Fix USB tether with Android and Selecting a USB WiFi adapter link

[[File:PineTab2 Front.jpg|250px|thumb|right|The PineTab2 with the detachable keyboard attached]]

The '''PineTab2''' is PINE64's successor to the original [[PineTab]] Linux tablet computer, featuring a faster processor and better availability. The tablet is available in two configurations, 4GB of RAM and 64GB of internal storage or 8GB of RAM and 128GB of internal storage. The tablet ships with a detachable keyboard that doubles as a protective cover.

The tablet is designed around the Rockchip RK3566 processor, which features 4 energy-efficient Cortex-A55 64-bit ARM cores and enjoys good mainline Linux support. A similarly packaged RISC-V tablet is the [[PineTab-V]].

Pre-orders started on the 13th of April 2023, with pricing starting at USD 159 for the 4GB/64GB version and USD 209 for the 8GB/128GB version. The PineTab2 began shipping on June 2, 2023.

== Getting started ==

The PineTab2 box contains two smaller boxes.

The first box includes:

* the PineTab2,
* a short user guide,
* a power cable and
* the UART adapter. Note that the UART adapter is in the same package as the power cable in a second compartment and can be a bit hidden.

The second box has the keyboard in it.

=== First start ===

The PineTab2 can be started by pressing and holding the power button for two seconds. The device is initialized at the first boot and will power-cycle while the partition table is populated.

{{Info|If the initialization process is interrupted it might lead to a corrupted operating system installation. In that case reinstall the operating system as explained below.}}

The PineTab2 ships with ''DanctNix Arch Linux'' and comes with a pre-set user and the default password <code>123456</code>.

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

You can create a new user and set your own password after the initial boot. To do so, go to ''system settings'' -> ''users'' and create a new profile using your preferred name and password.

=== Keyboard cover ===

When connecting the keyboard to the Pinetab2 ensure that the camera and the golden pogo pin connectors are correctly aligned.
The external keyboard has 5 connection pins (the golden pins). four are standard USB connectors and one is used to detect that the keyboard is connected.

The backlight can be changed with the key combination ''Pinekey + Ctrl (right)''.

== Software ==

All operating systems for the PineTab2 are delivered by community developers and partner projects. Aside from the operating system that comes pre-installed on your device, you can install and run any other operating system available for the PineTab2. Most, if not all operating systems for the PineTab2 are open and free, such as Linux and BSD.

Since most software issues will be release-specific, please see the [[PineTab2 Releases]] page for additional software related instructions, tips, and tricks.

=== Releases ===

The PineTab2 ships with ''Danctnix Arch Linux ARM''. The factory image can be found here:

* https://echo.danctnix.org:7269/danctnix-factory-image-20230527.img.xz (1.5 GB)

{{Info|The factory image is flashed to a microSD card and it will overwrite the eMMC installation after booting.}}

There are currently no stable releases. All releases for the PineTab2 will be listed under [[PineTab2 Releases]] as they're released. Your contributions are wanted!

=== Installation instructions ===

The PineTab2 is capable of running different operating systems from the internal flash memory (eMMC) and from microSD card.

'''Preparing the microSD card'''

To write an operating system to the microSD card (typically called "flashing" in the community), you need to first download a compatible image from the [[#Releases|releases]] section.

Next you need to decompress the downloaded image. The images are typically compressed in an archive format such as ''xz'' to reduce the download size. If you are using a graphical tool such as ''balenaEtcher'' or ''Gnome Disks'' it will handle the decompression of the image in the flashing step automatically.

Further you need to flash the image to the microSD card. This can be done using various tools, for example ''balenaEtcher'' (recommended for new users), ''Gnome Disks'' or command-line tools such as ''cp'' and ''dd''. Insert the microSD card in a microSD card reader connected to your computer and then choose a tool of your liking.

Graphical applications:

* '''balenaEtcher''' (Microsoft Windows, macOS, Linux): Click on ''Flash from file'' and select the image. Then select the microSD card target device and click on ''Flash!''.

* '''Gnome Disks''' (Linux): Select the microSD card target device on the left side in the ''Disks'' list. Then select the three dot menu on the top right and click on ''Restore Disk Image...''. Select the image, verify the correct device is selected and then click on ''Start Restoring...''.

Command-line tools:

* '''cp''': <code>sudo cp '''IMAGE.img''' /dev/'''[DEVICE]'''</code>

* '''dd''': <code>sudo dd if='''IMAGE.img''' of=/dev/'''[DEVICE]''' bs=1M status=progress conv=fsync</code>

{{Info|Make sure to replace '''IMAGE.img''' and '''[DEVICE]''' with the filename of the image (double check if it is decompressed and has the file extension ''.img'') and the device name. You can use the command <code>lsblk</code> to find the device name. Make sure to flash to the whole device instead of partition 1 and that you're NOT selecting ''/dev/sda1'' or ''/dev/mmcblk0p1'' as target. Be very careful to select the correct device, as the tools can overwrite your data when the wrong device is selected.}}

Then insert the microSD card into the PineTab2.

[[File:PineTab2 USB UARTv2.jpg|thumb|right|400px|Using the USB UART adapter can be required in some cases as explained in the info box about the boot order. The adapter is shipped with the PineTab2 in the box which is also containing the charging cable. The switch to disable the eMMC and SPI is located on the top right of the image.]]

{{Hint|'''Note regarding the boot order:''' The SPI and the internal memory (eMMC) have a higher boot priority than the microSD card. The pre-installed bootloader on the internal memory (eMMC) tries to boot from the microSD card first. '''In some cases''' it can be required to bypass the bootloader, for example if the bootloader is corrupted or was overwritten by a bootloader with varying settings. 

To force the device to boot from the microSD card, the eMMC and the SPI can be disabled by using the debug UART adapter shipped with the device in the box also containing the charging cable. Set the ''SD BOOT MASKROM'' switch on the adapter to the position ''ON'' and plug it into the USB/PD charging port. Then power on the tablet and '''unplug the debug board or set the switch to the position ''OFF'' again''' when the factory image is started, otherwise the factory image won't find the eMMC.}}

Power on the device with the microSD card inserted (and optionally with the USB UART adapter inserted and the bypass switch set to ''ON'' depending on the software situation, see the info box above). It should now boot the new operating system from the microSD card.

'''Something is not working?''' Please join the [[Main_Page#Chat_Platforms|PineTab channel in the community chat]], the community is always happy to help. In the section [[#Connecting the UART adapter]] you can find information about how to connect the USB UART adapter and how to retrieve the boot logs if the device is not booting properly even after the above procudere.

== Specifications ==

[[File:RK3566_icon.png|right]]
[[File:Pinetab2-side.jpeg|400px|right]]
* '''SoC:''' Rockchip RK3566
* '''CPU:''' 4x ARM Cortex-A55 @ 1.8 GHz
** 32KB L1 Instruction Cache and 32KB L1 Data Cache per core
** 512KB unified system L3 cache
** ARMv8 Cryptography Extensions
* '''GPU:''' Mali-G52 MP2 @ 800 MHz
** Supported by the open source 'Panfrost' driver in Linux and Mesa
** Supports OpenGL 3.1 and OpenGL ES 3.1 with many newer extensions
* '''NPU:''' 0.8 TOPS Neural Processing Unit
* '''RAM:''' 4GB or 8GB LPDDR4
* '''Storage:'''
** 64GB or 128GB internal eMMC ([https://www.szyuda88.com/product-77313-276594.html SiliconGo SGM8 100C-S36BCG]; eMMC 5.1, up o 400MB/s)
** 1x MicroSD slot
* '''Display:''' 10.1" IPS LCD Resolution 1280x800
* '''Cameras:'''
** Front: 2Mpx, chipset: Galaxycore GC02M2
** Rear: 5Mpx, chipset: Omnivision OV5648
* '''Battery:''' 6000 mAh (22.2Wh)
* '''Buttons:''' Power, volume up, volume down
* '''Network:'''
** Wi-Fi : BES2600
** Bluetooth : BES2600
* '''I/O:'''
** 1x USB-C 3.0 (top, host mode only; power output up to 680mA)
** 1x USB-C 2.0 + PD (bottom, device mode by default; power input)
** 1x MicroHDMI
** 1x 4 pole 3.5mm audio jack (microphone right) and headphone detection
** 2x speakers + microphone (microphone left)
** 1x 5 pin (USB 2.0; <=680mA) Pogo connector for keyboard
** (PCIe on PCB as a flat flex ribbon connector, no room for M.2 NVMe drives in case)
* '''Sensors:'''
** Accelerometer: Silan SC7A20
** Ambient Light & Proximity Sensor
* '''Multimedia:'''
** rkdjpeg: 1080p120 JPEG decode
*** no driver in mainline yet
** hantro: JPEG/VP8/H.264 encode, 1080p MPEG-2/H.263/VP8/H.264 AVC decode
*** mainline driver does not yet support all codecs/functions
*** see [[Mainline Hardware Decoding]] and [[Mainline Hardware Encoding]]
** rkvdec2: 4K H.264 AVC Main10 L5.1/H.265 HEVC Main10 L5.1/VP9 Profile 0 and 2 L5.1 decode
*** no driver in mainline yet
** rkvenc2: 4K H.264 AVC/H.265 HEVC encode
*** no driver in mainline yet
* '''Build:''' Metal and Plastic
* '''Dimensions:''' 242x161x9mm
* '''Weight:''' 538g
* '''Misc:'''
** Protective cover with keyboard

== Development efforts ==

{{SeeMainArticle|Quartz64 Development}}

Linux mainline is already quite far along for the device, as the SoC is the same as is used in the Quartz64 line of devices. Some minor pinetab2-specific adjustments can be found [https://github.com/TuxThePenguin0/linux/tree/device/pine64-pinetab2_stable here] Check the main article for the big picture; PineTab2 specific issues are listed here.

=== Known Issues ===

* The display panel driver is in PineTab2's kernel fork, and needs to be submitted to upstream.
* The [https://gitlab.com/TuxThePenguin0/bes2600 BES2600 Wi-Fi driver] needs major cleanup and bugfixing (at the moment it often causes system crashes). This is a priority, but for now, you can [[PineTab2_FAQ#Performing_USB_Tethering_with_an_Android_Phone|USB tether a phone]] or [[PineTab2_FAQ#Selecting_a_USB_WIFI_Adapter|use a supported WI-FI dongle]].
* The BES2600 Bluetooth driver needs to be implemented.
* The Camera drivers needs to be ported ([https://github.com/rockchip-linux/kernel/blob/develop-4.19/drivers/media/i2c/gc02m2.c gc02m2], [https://elixir.bootlin.com/linux/latest/source/drivers/media/i2c/ov5648.c ov5648]), Rockchip CSI/ISP driver needs to be extended to handle 2 lanes.
* Suspend does not currently work reliably due to a driver issue. It is therefore disabled in the factory image. Caveat Emptor if you chose to unmask the feature prior to it being fixed.

=== Connecting the UART adapter ===

The USB-C UART adapter can be connected to the PineTab2 to debug boot issues at the early boot:

* Plug the adapter face-up in the USB-C port furthest away from the power button. If all the lights are lit, you have the wrong port: only the green light should be lit when you first plug it in.
* Plug USB-C cable into the port on the adapter marked "DEBUG"
* Open a terminal window
* Install ''minicom'' or ''screen'' via your distribution's package manager, if you don't have it installed already
* Connect via minicom using <code>sudo minicom -D /dev/ttyUSB0 -b 1500000</code> or via screen using <code>sudo screen /dev/ttyUSB0 1500000</code>
** Ubuntu-based distro users may encounter the error, "cannot open /dev/ttyUSB0: No such file or directory". If this occurs, check the output of <code>sudo dmesg --follow</code> and unplug/replug the USB to look for any errors. If you see an error like, "usb 1-1: usbfs: interface 0 claimed by ch341 while 'brltty' sets config #1", then the brltty service is likely conflicting with this device. Brltty provides access to blind users who use a braille display: if you do not need this service, try disabling it using these commands:
*** <code> sudo systemctl stop brltty-udev.service</code>
*** <code> sudo systemctl mask brltty-udev.service</code>
*** <code> sudo systemctl stop brltty.service</code>
*** <code> sudo systemctl mask brltty.service</code>

== Board information, schematics and certifications ==

[[File:PPineTab2-pcb.jpg|thumb|right|PineTab2 Board]]

PineTab2 mainboard schematic:

* [https://files.pine64.org/doc/PineTab/PineTab2_V2_schematic-20230417.pdf PineTab2 mainboard Released Schematic-20230417 ver 2.0]

PineTab2 certifications:
* [https://files.pine64.org/doc/cert/Pinetab2%20FCC-SDOC%20Certificate-LCSA040323223E.pdf PineTab2 FCC Certificate]
* [https://files.pine64.org/doc/cert/Pinetab2%20CE%20RED%20Certificate-LCSA040323224E.pdf PineTab2 CE RED Certificate]
* [https://files.pine64.org/doc/cert/PineTab2%20CE%20EMC%20Certificate-LCSA040323225E.pdf PineTab2 CE EMC Certificate]
* [https://files.pine64.org/doc/cert/PineTab2%20ROHS%20Report-LCSA040323221R.pdf PineTab2 ROHS Test Report]
* [https://files.pine64.org/doc/cert/PineTab2%20Keyboard%20CE%20EMC%20Certificate-LCSA062623001E.pdf PineTab2/PineTab-V Detached Keyboard CE EMMC Certificate]

PineTab2 disassembly guide:
* [[file:PineTab2_display_panel_disassembly_guide.pdf]]
* Note: this is a very delicate operation esp. around the corners of the screen. Several (even experienced) users ended up damaging the screen.

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

== Tutorials and Frequently Asked Questions ==
Please see the [[PineTab2 FAQ]] page for tutorials and frequently asked questions.

== External Links ==

* [https://www.pine64.org/2022/12/15/december-update-merry-christmas-and-happy-new-pinetab/ December 2022 Community Update]
* [https://www.pine64.org/2023/03/01/february-update-things-are-taking-shape/ February 2023 Community Update]

[[Category:Rockchip RK3566]]

PineNote Development/Building Kernel

2023-03-03T21:58:34Z

Diederik: /* Available Kernel Repositories */

This page contains information on how to build a linux kernel for the [https://wiki.pine64.org/wiki/PineNote PineNote].

= Available Kernel Repositories =

The following (incomplete?) PineNote-specific kernel repositories are available:

* https://github.com/m-weigand/linux/ (based mainly on the repository from smaeul, with additional patches pulled in from other sources, Debian packages available)
* https://gitlab.com/pgwipeout/linux-next/
* https://github.com/smaeul/linux/tree/rk35/pinenote-next

= Building the kernel =

{{Info|These following instructions need to be cleaned up and updated, and OS-specific information and tweaks should be moved elsewhere}}

After following [https://github.com/DorianRudolph/pinenotes#starter-guide Dorian's directions] to get Arch installed you've seen someone [https://github.com/m-weigand/mw_pinenote_misc/blob/main/videos/20220808_bw_dither_mode_picture_doom_video_small.mp4 playing DOOM] and you want to learn how to get the features that enable that kind of performance. To get your PN running this smoothly, we'll need to build our own kernel. There are two kernel efforts underway right now:

# pgwipeout: https://gitlab.com/pgwipeout/linux-next
# smaeul: https://github.com/smaeul/linux/tree/rk35/pinenote-next

We'll be using smaeul's kernel + some additional patches provided by DorianRudolph, pgwipeout, Maximilian Weigand, occam_razor, and hrdl. Thanks so much to them, and all the other users who have worked on piecing together drivers, twiddling configs, answering questions, and sharing their work in other ways. Brava!

Perhaps the main component of the kernel is the DRM driver. You can read more about the driver by reading [https://lore.kernel.org/linux-rockchip/20220413221916.50995-1-samuel@sholland.org/T/ Smaeul's RFC].

=== A small warning ===

This guide is completely based off of the scripts provided by Maximilian. We'll be cloning and running them, but he owns them and he -- or others -- might change them. It's smart to have a look at what's going on, check when this page was last updated vs when his scripts were last updated, etc. Be nimble!

Additionally, as Maximilian warns [https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches here], these changes are all experimental and may damage your panel.

{{info|If anyone reading this has recommended reading for how we can understand what may damage our panels (IE is the risk in fast updates? The types of updates? something more complicated?), please add it here!}}

== What you should have already done ==

It is assumed you've already got an operating system installed on your Pinenote other than the stock Android. Doing this isn't trivial, but it is well understood - you will be following the footsteps of many others. Dorian Rudolph made a guide for doing this, available [https://github.com/DorianRudolph/pinenotes#starter-guide here].

== What do you need to know? ==

If you followed Dorian's guide to get here and felt semi-comfortable, you'll be fine. This is no more complicated than that. If you are intimidated, that's okay! I'll still encourage you to try :) you will learn a lot, just be patient and don't put any data on your PineNote that you wouldn't be okay losing. If you run into trouble, ask for help in the [https://discord.com/invite/pine64 Discord]/[https://matrix.to/#/#pinenote:matrix.org Matrix]. Please try to solve problems on your own first, and then ask for help -- if nobody replies, please be patient and ask again soon.

== Steps to build ==

1. Clone Maximilian's scripts:

$ git clone https://github.com/m-weigand/mw_pinenote_misc.git

2. Make a separate directory for patching the kernel. Then run Maximilian's ''clone_and_prepare_git.sh''. This will clone smaeul's kernel and a number of patches. Read the script to see which patches it is using. Feel free to open the patches too -- it's helpful to get a slim idea of what's going on, if only looking at the commit messages in them:

$ cd ../
$ sh mw_pinenote_misc/custom_kernel/clone_and_prepare_git.sh

3. Compile the kernel:

$ sh ./mw_pinenote_misc/custom_kernel/compile.sh

4. Next we want to perform the work captured in '''install_to_pn.sh''', but the work may vary slightly from person to person. As long as you put them somewhere and configure your '''extlinux.conf''' to point at it, things will be okay. Looking at '''install_to_pn.sh''', we can see that there are three pieces to installing the kernel: the kernel image (called ''Image''), the device tree (''rk3566-pinenote-v1.2.dtb''), and the modules. All of these files have been compiled and placed into the '''linux/pack''' folder. The easiest way to send these over is by using ''scp'' or ''rsync'' - read the script and decide how you would like to get your files in the correct location. You may need to install ''rsync'' on your PineNote if it doesn't already have it.

5. DTB was installed like this: <code>$ scp rk3566-pinenote-v1.2.dtb root@pinenote:/boot/dtbs/rockchip/</code>

6. After installing the DTB as above, the file '''/boot/extlinux/extlinux.conf''' may be updated to point to this new file

7. (Perhaps not necessary?) The last step is to generate a new initrd image (see [https://en.wikipedia.org/wiki/Initial_ramdisk Wikipedia] for an explanation about initial ramdisk). This is done on the PineNote itself. Send Maximilian's installation script over and run it. Then place the generated image (from the last step of the shell script) into your boot partition and update '''extlinux.conf''' if needed to point at this new file.

$ scp initrd/gen_uboot_image.sh root@pinenote:/root # Do this part on local to put script on PN
$ ssh root@pinenote # Or use UART, the dongle + picocom, and change to root
$ cd /root
$ ./gen_uboot_image.sh
$ mv initrd.img /boot/initrd.img
$ vim /boot/extlinux/extlinux.conf # Update this to reference this new initrd image

8. At this point your kernel is in place! However, there are a few more steps you may need to complete to ensure the display and networking continue to work:
* For display, you may need to change '''/lib/firmware/waveform.bin''' to '''/lib/firmware/rockchip/ebc.wbf''' (TODO: is this a difference between PG and smaeul's kernel or a patch?)
* For networking, you may need to change '''/lib/firmware/pinenote.bin''' to '''/lib/firmware/pinenote-v1.2.bin'''

9. This part technically isn't kernel specific, but we need to install a patched version of Mesa. If you are running an Arch based system, you're in luck! occam_razor provides prebuilt patched packages (say that 5 times fast) [https://github.com/0cc4m/pinenote-misc/releases here]. Simply extract these files, send them to PN, and install them using the package manager. You can also patch it yourself by looking at Maximilian's [https://github.com/m-weigand/mw_pinenote_misc/blob/main/compile_mesa.sh compile_mesa.sh].

{{Info|If you frequently update your system with ''pacman -Syu'', you will end up updating these packages and losing the patches. Add this line to your <code>/etc/pacman.conf</code> to prevent them from being updated: <pre>IgnorePkg = libva-mesa-driver mesa mesa-debug mesa-vdpau opencl-mesa vulkan-mesa-layers vulkan-broadcom vulkan-panfrost vulkan-radeon vulkan-swrast</pre>}}

10. To ensure the GPU stays on, we need to use Maximilian's [https://github.com/m-weigand/mw_pinenote_misc/blob/main/systemd/mweigand_eglinfo.service mweigand_eglinfo.service]. The ''Readme.md'' in that same directory has instructions for how to install this, but basically we need to copy it to '''/etc/systemd/system/''', run <code>sudo systemctl daemon-reload</code> to make sure systemd knows it exists, then execute <code>sudo systemctl enable mweigand_eglinfo.service</code>.

= Next steps =
== Configuring the driver ==
The driver has several options that can improve performance. These can be read about [https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#new-features-as-of-2022august08 here]. <code>rockchip_ebc.bw_mode=1 rockchip_ebc.default_waveform=1 rockchip_ebc.refresh_threshold=30 rockchip_ebc.auto_refresh=1</code> may be used to make the image lower quality, but much faster to update. The auto_refresh setting is also essential to clear ghosting which will otherwise accrue on screen. The ''APPEND'' line in the '''extlinux.conf''' might be added to make sure they are applied on boot.

== Fixing suspend ==
If you're using a logind system, edit your '''/etc/systemd/logind.conf''' config. More information on what to do [https://wiki.archlinux.org/title/Power_management#ACPI_event in Arch's documentation].

== Configuring your apps ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Apps this page].

== Booting Linux instead of Android ==
[[PineNote Development/Booting Linux]]

== Fixing Bluetooth ==
See [[PineNote Development/Software Tweaks]]

[[Category:PineNote]]

QuartzPro64 Development

2023-02-25T23:40:53Z

Diederik: Update link to v4 of "AV1 stateless decoder for RK3588" patch series

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

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

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

= Obtaining a Development Board =

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

= Upstreaming Status =

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

= Hardware =

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

== General ==

* RK3588 SoC (8 cores: 4x A76@2.4GHz + 4x A55@1.8GHz)
* Mali G610MC4 GPU (4x Valhalla cores)
* 16 GB LPDDR4X (SK hynix)
* 64 GB eMMC (soldered)
* 1x USB-C (with video-alt mode)
* 1x USB-C (FTDI debug UART)
* 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 WiFi & BT Module
* 2x SMA Antenna
* 2x MIPI DPHY
* 1x MIPI D/C PHY
* 1x MIPI CSI
* 1x Fan header
* 1x RTC battery socket
* 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 ==

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

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

== Storage ==

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

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

== Power ==

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

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

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

== PMU ==

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

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

Verify this once we have access to SDK sources.

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

== Ethernet ==

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

The other port (near the sound jack) is hooked to the SoC via PCIe and is currently 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 ?

TODO: Add unbricking informations (for example: can the SPI be rewritten with rkdeveloptool)

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

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

$ rkdeveloptool list

should now show you the device somewhat like this:

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

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

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

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

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

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

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

=== Setting Up The SD Card ===

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

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

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

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

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

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

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

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

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

=== Creating The Root File System ===

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Booting ===

Unplug the download USB-C cable once done.

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

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

== Using neg2led's kernel branch ==

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

Create the additionnal partition:

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

Mount it:

# mount /dev/sda4 /mnt/sdcardroot

Extract the ALARM rootfs tarball in there:

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

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

root=/dev/mmcblk1p5

= Resources =

== Kernel ==

* [http://lists.infradead.org/pipermail/linux-rockchip/ The linux-rockchip mailing list archives]
* [https://patchwork.kernel.org/project/linux-rockchip/list/ linux-rockchip patchwork]
* [https://github.com/neg2led/linux-quartz64 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]

== Misc ==

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

== Documentation ==

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

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

ROCKPro64 Software Releases

2023-02-19T14:34:32Z

Diederik: Fix LibreELEC download link (and fix LE capitalization)

This page contains a list of all available releases and tools for the [[ROCKPro64]] in alphabetical order.

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

'''AOSC OS''' is a general purpose Linux distribution that strives to simplify user experience and improve free and open source software for day-to-day productivity. Originally AnthonOS (an OpenSUSE derivative built with SUSE Studio), then remade as a Debian derivative with customized KDE 4 UI and CJK support. To learn more about AOSC, please visit the official [https://aosc.io/ AOSC website]

Download:
* https://aosc.io/downloads/ (supports the microSD card and eMMC, 8GB or more)

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

----

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

'''Armbian''' is a Linux distribution designed for ARM boards. They are usually Debian or Ubuntu flavored. To find out more about Armbian and available options please visit their [https://www.armbian.com/rockpro64/ site]. If you are booting from a Micro SD card, then both Linux kernel versions will work. If you are trying to boot from an eMMC module then the 4.4.y will work, but the newer 5.10.y will not.

Download:
* https://dl.armbian.com/rockpro64/archive/

----

=== Batocera Linux ===
[[File:batocera.png|right|100px]]

'''Batocera Linux''' is an open-source and completely free retro-gaming distribution that can be copied to a USB stick or an SD card with the aim of turning any computer/nano computer into a gaming console during a game or permanently. Visit the project's website here (https://batocera.org/). You can follow the ongoing discussion about batocera.linux on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=7084)

Download:
* https://batocera.org/download

----

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

'''Debian''' is an operating system and a distribution of free software. See the forum thread [https://forum.pine64.org/showthread.php?tid=9744 here].

Download:
* [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ Debian 11 Bullseye] (recommended)
* [https://deb.debian.org/debian/dists/bookworm/main/installer-arm64/current/images/netboot/SD-card-images/ Debian 12 Bookworm]
* [https://d-i.debian.org/daily-images/arm64/ Daily netboot images]

Instructions:
* Download: <code>firmware.rockpro64-rk3399.img.gz</code>
* Download: <code>partition.img.gz</code>
* Create the disk image:
** For Linux: <code>zcat firmware.rockpro64-rk3399.img.gz partition.img.gz > complete_image.img</code>
** For Mac: <code>gzcat firmware.rockpro64-rk3399.img.gz partition.img.gz > complete_image.img</code>
* Write the image to your boot device:
** For Linux: <code>dd if=complete_image.img of=your_chosen_boot_device bs=4M</code>
** For Mac: see [[Getting started]]

Notes:
* An Ethernet connection is required for the above installer
* See the [[ROCKPro64#No_Video_or_GPU_Acceleration_on_Debian|troubleshooting section]] if you encounter issues with GPU acceleration.

----

=== 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 ROCKPro64 build on the [https://forum.pine64.org/showthread.php?tid=12532 PINE64 forum thread].

Download:
* [https://dietpi.com/downloads/images/DietPi_ROCKPro64-ARMv8-Bullseye.7z Direct download from dietpi.com]

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

----

=== LibreELEC ===
[[File:libreelec.jpg|right|100px]]
'''LibreELEC''' is a lightweight 'Just enough OS' Linux distribution purpose-built for Kodi on current and popular mediacentre hardware.

Download:
* [https://libreelec.tv/downloads/rockchip/ Official LibreELEC build image] (look for PINE64 RockPro64-LibreELEC-RK3399.arm-x.x.x-rockpro64.img.gz, supports microSD card and the eMMC module of 8GB or more.)

{{Info|Unzip and flash the image to a microSD card or eMMC module, for example using ''dd''.}}

----

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

'''Manjaro''' is a user-friendly Linux distribution based on the independently developed Arch operating system. To learn more about Manjaro please visit [https://forum.manjaro.org/c/arm/releases/102 Manjaro forum].

Download:
* [https://github.com/manjaro-arm/rockpro64-images/releases from Github]

Notes:
* Decompress the image (<tt>unxz</tt>) before flashing, or decompress on the fly while flashing (<tt>xzcat</tt> in a root shell, Etcher, ...)
* A display and keyboard will be required for first boot.
* Initial setup includes: keyboard layout, locale, username, user password, and root password.
* The installer will expand the root partition to use the remaining space on the storage device you've flashed.

----

=== Nems Linux ===
[[File:nems.jpg|right|100px]]

'''NEMS''' stands for ''Nagios Enterprise Monitoring Server'' and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers. To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread].

Download:
* [https://nemslinux.com/download/nagios-for-pine64.php Download page] with torrent seed or direct download.

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

----

=== NixOS ===
[[File:NixOS.webp|right|100px]]

'''NixOS''' is a Linux distribution built on top of the Nix package manager using declarative configuration to allow reliable system upgrades. More information can be found on the [https://nixos.wiki/wiki/NixOS_on_ARM/PINE64_ROCKPro64 NixOS wiki].

Download:
* [https://github.com/AshyIsMe/nixos-installer-rockpro64 nixos-installer-rockpro64]

----

=== OpenMediaVault ===
[[File:omv.png|right|100px]]

'''OpenMediaVault''' is the next generation network attached storage (NAS) solution, [https://www.openmediavault.org/ click this link to OMV main page] to learn more. Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6308 here]

Download:
{{Outdated release}}
* Stretch 32bit (armhf): [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
* Stretch 64bit (aarch64): [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]

Notes:
* You need to enable root login in OMV WebGUI
* [http://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! TTY and SSH, except OMV
| <code>rock64/rock64</code>
|-
! WebGUI Login
| <code>admin/openmediavault</code>
|-
! TTY and SSH
| <code>root/openmediavault</code>
|}

----

=== OpenWrt ===
[[File:OpenWrt.png|right|100px]]

'''OpenWrt''' is a highly extensible GNU/Linux distribution for embedded devices (typically wireless routers). Unlike many other distributions for these routers, OpenWrt is built from the ground up to be a full-featured, easily modifiable operating system for your router. In practice, this means that you can have all the features you need with none of the bloat, powered by a Linux kernel that's more recent than most other distributions.

Download:
* https://openwrt.org/toh/pine64/rockpro64_v2.1

----

=== R-Cade ===
[[File:RCadeLogo.jpg|right|100px]]

Retro Center's '''R-Cade''', the 4K Media Center Arcade. [https://www.retro-center.com/about-r-cade/ RCade] Features 100+ retro-gaming systems, a lightweight web browser, and full 4K UHD media playback.

Download:
* [https://github.com/retro-center/rcade_releases/releases Direct download from Retro Center's GitHub] (USB, microSD and eMMC boot)

----

=== Recalbox ===
[[File:RB.png|right|100px]]

'''Recalbox''' allows you to re-play a variety of videogame consoles and platforms in your living room, with ease! Visit the project's website here (https://www.recalbox.com/). You can follow the ongoing discussion about Recalbox on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=7194)

Download:
{{Template:Outdated release}}
* [https://github.com/mrfixit2001/recalbox_rockpro64/releases download] release from mrfixit2001 github.

----

=== Retro Arena ===
[[File:retroarena.png|right|100px]]

'''Retro Arena''' community build for microSD and eMMC boot. This is a BETA and therefore is not update-able nor supported, however bugs or issues are appreciated to be identified and shared via the issues tab on our GitHub so that we can address them in the future. The Roshambo Case support is baked in with one major caveat due to kernel limitation: You can power the unit off by the POWER switch and the RESET button works 100% however to power the unit on you will need to manually plug/unplug the power cord. This limitation will not be present in future releases. You can follow the ongoing discussion about Retro Arena on the [https://forum.pine64.org/showthread.php?tid=7555 forum]

Download:
{{Outdated release}}
* [http://files.pine64.org/os/ROCKPro64/odroidretroarena/TheRA-RP64-BETA-0.8-FINAL.img.gz Direct download from pine64.org]

----

=== SkiffOS ===
[[File:SkiffOS-Icon-1.png|right|100px]]
Minimal cross-compiled OS optimized for hosting distributions in Docker containers. Provides the reliability of firmware with the ease-of-use of package managers. Uses the [http://buildroot.org Buildroot] cross-compilation tool for support for all Pine64 boards.

Use configuration packages to configure the distribution:
* core/gentoo: Gentoo optimized for Rockpro64
* core/nixos: NixOS arm64

You can also configure the skiff core yaml file to configure multiple distributions to run in parallel.

The boot-up OS can be upgraded independently from the containers.

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

----

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

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

Resources:
* [https://docs.slackware.com/slackwarearm:inst Installation instructions].
* [https://www.youtube.com/watch?v=uXAL9jz-yaA&list=PL1XOSJnvang3VLmqke2QbRitKtOD6Rm3t Installation video guide]

----

=== slarm64 ===

'''slarm64''' is an unofficial aarch64 / riscv64 Slackware Linux port. You can follow the ongoing discussion about slarm64 on the RockPro64 on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=6823) or this forum thread for more general slarm64 information: https://www.linuxquestions.org/questions/slackware-arm-108/slarm64-aarch64-unofficial-slackware-4175613287/.

Downloads:
* [http://dl.fail.pp.ua/slackware/images/rockpro64/ download] (supports microSD card, look for slarm64-current-aarch64-xfce-rockpro64-x.xx.x-build-xxxxxxxx.img.zst)

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

Flashing the distribution to the eMMC:
* Flash the image to micro SD, power up the board with micro SD and login
* Copy the image file to micro SD by using SFTP. The image file must have the ''.img'' file extension.
* After finish copy the file, power off the board and add eMMC module to the board
* Boot the board, run below command for flashing to eMMC module
* Run <code>dd if=[image file] of=/dev/mmcblkX bs=10M</code> (example: ''sudo dd if=slack-current-aarch64-xfce_29Sep18-4.4.162-rockpro64-build-20181126.img of=/dev/mmcblkX bs=10M'')
* then edit these two files in eMMC module:
** <code>mount /dev/mmcblk1p1 /media</code>
** <code>echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt</code>
** <code>sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab</code>
* After that, power off the board and remove the microSD card. Then boot with only the eMMC module.

----

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

'''Twister OS''' brings a desktop computing experience for SBCs, right out-of-the-box. Including themes, applications, tools, and optimizations to get the most out of your SBC. For more information on Twister OS, please visit the [https://twisteros.com/ official site]. You can follow the ongoing discussion about Twister OS on the PINE64 forum (https://forum.pine64.org/showthread.php?tid=12192).

Download:
* [https://twisteros.com/twisterarmbian.html Twister OS Armbian-Reforged XFCE Desktop image] (2.8GB, supports the microSD card and eMMC modules with 16GB and more)

{{Info|After flashing image with Etcher, edit /boot/armbianEnv.txt, replace the dtb name with rk3399-rockpro64.dtb.}}

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

----

=== Void Linux ===
'''Void Linux''' is a general purpose operating system, based on the monolithic Linux kernel. The official guide can be found at [https://docs.voidlinux.org/installation/guides/arm-devices/index.html Guide]. At this time there are no RockPro64 images available.

The following creates a bootable image from an existing Void Linux installation:
* <code>xbps-insall -Syu</code> to update the xbps installation of the installation
* create ROCKPro64 image with the ''void-mklive'' software (from github.com):
** create a rootfs via ''mkrootfs.sh'': <code>sh mkrootfs.sh -o void-aarch64-muls-ROOTFS-yyyymmdd.tar.xz</code>
** <code>sh mkplatformfs.sh rockpro64 void-aarch64-muls-ROOTFS-yyyymmdd.tar.xz</code>
** <code>sh mkimage.sh -s 7GiB void-rockpro64-PLATFORMFS-yyyymmdd.tar.xz</code>
* write image to sdcard or eMMC: <code>dd if='''IMAGE-FILENAME''' of='''DEVICENAME''' bs=2M</code>
* If ''mkplatformfs.sh'' errors with ''ROCKPro64 not supported'', install ''xbps-src'' from https://github.com/void-linux/void-packages and build the ROCKPro64 package.
* Tip: write a new U-Boot to the image if you see on the serial console the boot-up stalls:
** get the two U-Boot files from [https://pkgs.org/download/u-boot-rockpro64 pkgs.org], the aarch64 files:
** <code>dd if=idbloader.img of=DEVICENAME seek=64</code>
** <code>dd if=u-boot.itb of=DEVICENAME seek=16384</code>

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

== BSD Images ==
=== FreeBSD ===
[[File:Freebsd_Logo.png|right|100px]]

'''FreeBSD''' is an operating system used to power modern servers, desktops, and embedded platforms. The [https://wiki.freebsd.org/arm/RockChip#RockPro64 RockChip FreeBSD page] has instructions for installing FreeBSD. Version 13.0 and greater include prebuilt images.

Download:
* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! SSH user (enabled by default)
| <code>freebsd/freebsd</code>
|-
! Root user
| <code>root/root</code>
|}

Notes:

* The wiki has instructions on [https://wiki.freebsd.org/arm/RockChip#Fan_Control_on_RockPro64 enabling the PWM cooling fan].

----

=== NetBSD ===
[[File:netbsd.png|right|100px]]
'''NetBSD''' is a free, fast, secure, and highly portable Unix-like Open Source operating system. To learn more about NetBSD please visit [https://www.netbsd.org/ NetBSD main page]

Download:
* [https://armbsd.org/ download] latest release build from NetBSD by select 64bit - RockPro64 (size: 339 MB)

{| class="wikitable"
!colspan="2" style="background: #a7d7f9;"| Default credentials
|-
! Root user and SSH login
| <code>root/[none]</code>
|}

Notes:
* Instructions concerning enabling SSH can be found [https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-ssh here] or the bootable image from armbsd.org can have the MSDOS partition modified to setup SSH using [https://man.netbsd.org/creds_msdos.8 this] method.

----

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

'''OpenBSD''' is a security-focused, free and open-source, Unix-like operating system based on the Berkeley Software Distribution. Official instruction to get OpenBSD on ROCKPro64 is [https://www.openbsd.org/arm64.html here], and blogs on installation [https://github.com/jasperla/openbsd-rockpro64 is here] and [https://bsandro.tech/posts/openbsd-7.1-on-pine64-rockpro64/ here]. Forum discussion is [https://forum.pine64.org/forumdisplay.php?fid=109 here].

== Chromium OS ==
[[File:chromium.jpg|right|100px]]

The '''Chromium OS''' community build image for microSD card and eMMC module, version beta (R76). To learn more please visit the [https://forum.pine64.org/showthread.php?tid=7659 forum].

Download:
{{Outdated release}}
* https://github.com/ayufan-rock64/chromiumos-build/releases/

{{Info|Flash the image to a microSD card or an eMMC module, for example using ''dd''.}}

== Android ==
=== Android 9.0.0 ===
[[File:android_9.png|right|100px]]

'''Stock for DD method [eMMC Boot] [20200804]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Supports new RockPro64 AP6256 Wifi/BT module
* Support Sony IMX214 camera module and works on both MiPi-CSI ports
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 8GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 7287fd0846616354615c8d3eff6a2a92
*** File Size: 602MB
* DD image for 16GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 78352bbf21198d062af8bab2217ee691
*** File Size: 611MB
* DD image for 32GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): c5c8dce419478f75f85f893ee4808dbd
*** File Size: 624MB
* DD image for 64GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200804_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): aab1cf4d30c4d16e6ce2672f3ecae935
*** File Size: 666MB

'''Stock for RK Flash tool [eMMC Boot] [20200804]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20200708_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): 9ac830527814521e15b009fa2503c9e3
** File Size: 589MB

'''Stock for DD method [eMMC Boot] [20200708]
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Supports new RockPro64 AP6256 Wifi/BT module
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 8GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): ef5f5a890a9270734e0adee21f006837
*** File Size: 597MB
* DD image for 16GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 179bd684a468f800a86f7c658a543bef
*** File Size: 606MB
* DD image for 32GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): d930b757c4427be07b83c37a9c8494a1
*** File Size: 630MB
* DD image for 64GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20200708_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09a970d68a10bdb3d6495d55860940e6
*** File Size: 660MB

'''Stock for RK Flash tool [eMMC Boot] [20200708]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20200708_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): 6d060ddd47ebcfd5cfcdbf90ec042c97
** File Size: 589MB

'''Stock for DD method [eMMC Boot] [20190427]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Please ignore "internal problem with your device" popup message if appear on Android boot-up page.
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 16GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190417_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 3BA4C72D81BCFC4C21B3B5D2BCB4F9F7
*** File Size: 609MB
* DD image for 32GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190417_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4965CCF50A8F06CEB2E4A6828A21F31C
*** File Size: 627MB
* DD image for 64GB eMMC module
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190417_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 748EC28FE5D5395D33E858C913D744BF
*** File Size: 663MB

'''Stock for DD method [microSD Boot] [20190506]'''
* DD image to microSD card and boot.
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* Please ignore "internal problem with your device" popup message if appear on Android boot-up page.
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image for 8GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): E1C551E8106E178841E1C3F71432194A
*** File Size: 599MB
* DD image for 16GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 73592FDD5A2F52F08020F16AD99E8C8C
*** File Size: 609MB
* DD image for 32GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 74DE0FE528F210E4DD483B411A71904B
*** File Size: 627MB
* DD image for 64GB microSD card
** [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20190506_stock_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D7626BD50443A88AEB9254C88C575284
*** File Size: 663MB

'''Stock for RK Flash tool [eMMC Boot] [20190427]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20190417_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): 046BA4A07933120809FBE1B9577B7341
** File Size: 592MB

----

=== Android 8.1.0 ===
[[File:android_8.png|right|100px]]
'''Stock for DD method [eMMC Boot] [20180828]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20180828_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 9AEE21BC1B9DE886DCB0E64FA123988A
** File Size: 414MB

'''Stock for DD method [microSD Boot] [20181212]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* DD image (for 8GB microSD card and above)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20181212_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 5A6BB7FCD7B3F77FCEE99CE462AE7405
** File Size: 616MB

'''Stock for RK Flash tool [eMMC Boot] [20180828]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180828_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 4DACFE927BB09EE9C56B5232A7F624EE
** File Size: 415MB

----

=== Android 7.1.2 ===
[[File:android_7.png|right|100px]]
'''Stock for DD method [eMMC Boot] [20180809]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20180809_stock_android_7.1_emmcboot.img.gz Direct download from pine64.org]
** MD5 (XZ file): 00F194017557017C2588724686E90CEA
** File Size: 498MB

'''Stock for RK Flash tool [eMMC Boot] [20180809]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180809_stock_android_7.1_emmcboot.img.gz Direct download from pine64.org]
** MD5 (XZ file): 197A9905B48441D8655E7542F4643FE9
** File Size: 483MB

'''Stock for DD method [microSD Boot] [20180920]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180920_stock_android_7.1_sdboot.img.gz Direct download from pine64.org]
** MD5 (XZ file): CE39642A379B357BB3E4BC80ACA2E0CE
** File Size: 765MB

'''Stock for DD method [eMMC Boot] [20180518]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_dd_20180518_stock_android_7.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 33622034ACDBC31A7D7BB01ED634E29B
** File Size: 345MB

'''Stock for RK Flash tool [eMMC Boot] [20180518]'''
* Please unzip first and then using Android tool to flash in
* The OTG port located at USB type-C connector, needs USB type A to type C cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180518_stock_android_7.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 90C1991DADAE13ADC94E927F171F8920
** File Size: 342MB

'''Stock for install from SDcard to eMMC [microSD Boot] [20180921]'''
* Use 'dd' to write the image to the eMMC module using the USB-to-eMMC adapter module and boot. Using [https://www.balena.io/etcher/ Etcher] or another specialized SD writing tool is preferred.
* Please allow 3-5 minutes boot up time on first time for initialization
* This build supports PINE64 7" LCD panel with tablet UI (not Android TV)
* [http://files.pine64.org/os/ROCKPro64/android/ROCKPro64_20180921_stock_android_7.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): c6900e82a1d6ef397dcac241f76f43c9
** File Size: 350MB

----

=== Android SDK ===
'''Android P SDK [v9.0]'''
* [http://files.pine64.org/SDK/ROCKPro64/ROCKPro64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 3CEBEEFD1A873BEEEC149148A785D92E
** File Size: 125.16GB

----

=== Slash TV OS ===
Android 7 based system including Play Store, working only from SD card (does not boot when installed on eMMC)
* https://drive.google.com/drive/folders/1K5YhWaB7Xstuv2HCo1HkpglCEm9x-RIM

== Development resources ==

The Ayufan github page
* [https://github.com/ayufan-rock64/linux-build/releases github.com/ayufan-rock64/linux-build/]

Below are the LPDDR4 driver for RK3399

* [http://files.pine64.org/os/ROCKPro64/driver/rk3399_loader_v1.10.112_support_1CS.bin rk3399_loader_v1.10.112_support_1CS.bin, this is 800Mhz version used in Android Build]
* [http://files.pine64.org/os/ROCKPro64/driver/rk3399_ddr_666MHz_v1.11.bin rk3399_ddr_666MHz_v1.11.bin, this is alpha version]
* [http://files.pine64.org/os/ROCKPro64/driver/rk3399_ddr_933MHz_v1.11.bin rk3399_ddr_933MHz_v1.11.bin, this is alpha version]

ROCKPro64 related files

* [http://files.pine64.org/os/ROCKPro64/driver/kernel_rockpro64.tar.gz ROCKPro64 Kernel file]
* [http://files.pine64.org/os/ROCKPro64/driver/trust.img trust.img]

== Miscellaneous tools ==

* [http://files.pine64.org/doc/rock64/tools/DriverAssitant_v4.5.zip Windows ADB driver package]
* [[ROCK64 MAC Address]]
* [http://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]
* [http://files.pine64.org/doc/rock64/tools/SD_Firmware_Tool._v1.46.zip Tools to burn Android build into a bootable microSD card]
* [http://files.pine64.org/doc/rock64/tools/AndroidTool_Release_v2.38.zip Tools that allows developer flash image into eMMC's Loader/Parameter/Misc/Kernal/Boot/Recovery/System/Backup partition]

[[Category:ROCKPro64]]

Quartz64

2023-02-15T16:17:20Z

Diederik: Mention that bluetooth fix is included in 6.1-rc7

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

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 from the eMMC or microSD card, see [[#Boot order|boot order]]. There doesn't seem to be a way to boot from USB devices or SATA yet.

The board can be booted by flashing your favorite operating system to a microSD card using another device and to insert 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 to overwrite the eMMC from within the booted operating system.

=== Boot order ===

The hardware boot order of the Quartz64 is:

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

== 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 '''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
* 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|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 [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 ''[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" 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]

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

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

[[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. 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 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 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 ''/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

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

PineNote Development

2023-02-05T14:06:32Z

Diederik: Mention non-free-firmware archive area for firmware in Bookworm and later releases

This article seeks to provide general mainline Linux development information for the [[PineNote]].

== Mainline development ==

=== Status ===

The following table aims to provide a list of kernel modules required for running the PineNote. It also aims at listing repositories of work in progress. While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]]) is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Module
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver is not mainlineable; it is only needed [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48 (via a hack)] for suspend/resume to work when downstream TF-A is used. Suspend on upstream TF-A ([https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952 status]) should work without any special drivers.
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/linus/c7a43b089826b17e46419d93c00c0d2f4b26735f]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled. Enabling the <code>gpu</code> node upstream needs to wait till <code>rockchip-ebc</code> is upstreamed.
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

=== Mainlining notes ===

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== Pages discussing the development efforts ==

The software releases can be found here in the future:

* [[PineNote Software Releases]]

The following pages discuss the development efforts for the PineNote:

* [[PineNote Development]]
* [[PineNote Development/Flashing]]
* [[PineNote Development/Booting Linux]]
* [[PineNote Development/Building Kernel]]
* [[PineNote Development/TODOs]]

For tweaks and tricks see:
* [[PineNote Development/Software Tweaks]]

For app development see:
* [[PineNote Development/Apps]]

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

The '''extlinux.conf''' should have the following contents:

timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT

At the U-Boot console, run the following command to boot your mainline kernel:

sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:

mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):

adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:

dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section; in Bookworm and later it's in the non-free-firmware section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt). The content of the upstream .txt is different than the Android configuration, but is supposed to work.

As you don't have WiFi yet you need to get the ''firmware-brcm80211*.deb'' and ''brcmfmac43455-sdio.txt'' file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the ''bluez-firmware'':

sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===

* https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in ''/sys'' to alter the refresh mode
* https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection

== Further information ==
=== Notes Written by Some Developers ===

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

=== Alternative to patching of mesa ===

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

=== Video of Factory Android OS ===

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge ("adb") over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running <code>adb</code>.

[[Category:PineNote]]

PineNote Development/TODOs

2023-02-05T00:37:28Z

Diederik: Fix link to possible audio fix

= Kernel/driver TODOs =
These exist, but they haven't been written down yet.

= Userspace TODOs=
The TODOs in this space are organized around what functionality they enable. A table of the important functions that a user may want in the PineNote and a status are listed below:

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Functionality
! scope="col" | Approaches (apps)
! scope="col" | Level of support (subjective)
! scope="col" | Supports
! scope="col" | Does not yet support
! scope="col" | Notes
|-
! scope="row" rowspan="3" | Reading Documents
| <code>[https://github.com/koreader/koreader Koreader]</code>
! style="background:LightGreen; text-align:center;" | Great
| Fully featured ebook reader; Supports many filetypes;
| Handwritten notes
| Large user base on many devices; codebase has a somewhat of a reputation for being messy
|-
| <code>[https://github.com/xournalpp/xournalpp Xournalpp]</code>
| style="background:LightGreen; text-align:center;" | Good
| Reading/writing PDFs and other files;
| No definition support (long-press for definition)
| Billed more as a note-taking app than a document reading app
|}

== Themes ==
A lot of getting the PineNote to work nicely will be theming things appropriately. Please list themes for various components here:
=== GNOME ===
Untested: https://github.com/fujimo-t/gnome-shell-theme-e-ink

=== GTK ===
TODO

== GNOME Configurations ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Apps#Gnome here].
== Sway Configurations ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Apps#Sway here].

= Documentation TODOs =

* Pin Mesa Packages so they don't update when we upgrade other packages
** Add the information near step 5 [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel#Steps_to_build here].
* Control the backlight
* Building alacritty correctly
* Force a screen refresh?
** See conversation here: https://matrix.to/#/!QtTzSRYMuozjbOQkzJ:matrix.org/$tfumBpnP2UPouNpaeFrggR40ZkrD_pHAtJdQmQvzL-o?via=matrix.org&via=kde.org&via=tchncs.de

== Status table draft ==

This table is a draft for the wiki development page:

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Functionality
! scope="col" style="min-width: 260px;" | Component
! scope="col" style="width: 120px;" | Status (Android from factory)
! scope="col" style="width: 120px;" | Status (Linux)
! scope="col" | Notes
|-
! | Bootloader
| <code>Bootloader</code>
| style="background:LightGreen; text-align:center;" | Android only
| style="background:LightYellow; text-align:center;" | WIP for Linux
| Booting into linux requires a patched U-Boot. [https://wiki.pine64.org/wiki/PineNote_Development/Booting_Linux Instructions here.]
|-

! scope="row" rowspan="4" | Operating System

| <code>Stability</code>
| colspan="2" style="background:LightYellow; text-align:center;" | WIP
| Users have successfully booted Arch, Manjaro, and Debian. Debian has most support right now.
|-
| <code>Suspend</code>
| colspan="2" style="background:LightGreen; text-align:center;" | Works
| [https://gitlab.com/hrdl/pinenote-shared/-/blob/main/patches/linux/0001-Rudimentary-attempt-to-keep-PMIC-usable-after-suspen.patch This kernel patch] adds suspend support.
|-
| <code>Updates</code>
| colspan="2" style="background:LightYellow; text-align:center;" | WIP
| GPU libs (mesa) and mutter rely on patched packages. These should not be updated via the package manager at the moment, make sure to exclude them.
|-
| <Code>Networking</code>
| colspan="2" style="background:LightGreen; text-align:center;" | Works
|
|-

! scope="row" rowspan="5"| Components

| <code>E-Paper Display</code>
| colspan="2" style="background:lightyellow; text-align:center;" | WIP
| Mostly functional. There is some ghosting and work remains, but the device and screen are usable.
|-
| <code>Touch</code>
| colspan="2" style="background:LightGreen; text-align:center;" | Works
|
|-
| <code>Bluetooth</code>
| colspan="2" style="background:LightGreen; text-align:center;" | Works, audio stutters
| [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel#Fixing_Bluetooth Switching the driver] provides stable connections for keyboards, but audio still stutters. Trying to fix this [https://wiki.pine64.org/wiki/PineNote_Development/Software_Tweaks#Preliminary_fix_for_stuttering_bluetooth_audio here].
|-
| <code>Sensors</code>
| colspan="2" style="background:LightBlue; text-align:center;" | Unsure
| Light sensors? Rotational sensors?
|-
| <code>Buttons</code>
| colspan="2" style="background:LightGreen; text-align:center;" | Works
| Power button works.
|-

! | Accessory compatibility, spare parts

| <code>Spare parts</code>
| colspan="2" style="background:lightcoral; text-align:center;" | Not available yet
| Spare parts currently not available yet in the store.
|-
|}

[[Category:PineNote]]

PineNote Development

2023-01-14T14:07:45Z

Diederik: point st-accel-i2c upstream link to actual commit of the driver

This article seeks to provide general mainline Linux development information for the [[PineNote]].

== Mainline development ==

=== Status ===

The following table aims to provide a list of kernel modules required for running the PineNote. It also aims at listing repositories of work in progress. While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]]) is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Module
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver is not mainlineable; it is only needed [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48 (via a hack)] for suspend/resume to work when downstream TF-A is used. Suspend on upstream TF-A ([https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952 status]) should work without any special drivers.
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/linus/c7a43b089826b17e46419d93c00c0d2f4b26735f]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled. Enabling the <code>gpu</code> node upstream needs to wait till <code>rockchip-ebc</code> is upstreamed.
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

=== Mainlining notes ===

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== Pages discussing the development efforts ==

The software releases can be found here in the future:

* [[PineNote Software Releases]]

The following pages discuss the development efforts for the PineNote:

* [[PineNote Development]]
* [[PineNote Development/Flashing]]
* [[PineNote Development/Booting Linux]]
* [[PineNote Development/Building Kernel]]
* [[PineNote Development/TODOs]]

For tweaks and tricks see:
* [[PineNote Development/Software Tweaks]]

For app development see:
* [[PineNote Development/Apps]]

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

The '''extlinux.conf''' should have the following contents:

timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT

At the U-Boot console, run the following command to boot your mainline kernel:

sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:

mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):

adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:

dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt). The content of the upstream .txt is different than the Android configuration, but is supposed to work.

As you don't have WiFi yet you need to get the ''firmware-brcm80211*.deb'' and ''brcmfmac43455-sdio.txt'' file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the ''bluez-firmware'':

sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===

* https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in ''/sys'' to alter the refresh mode
* https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection

== Further information ==
=== Notes Written by Some Developers ===

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

=== Alternative to patching of mesa ===

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

=== Video of Factory Android OS ===

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge ("adb") over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running <code>adb</code>.

[[Category:PineNote]]

PineNote Development

2023-01-14T11:48:35Z

Diederik: Add reason why 'gpu' node in dts(i) hasn't been enabled upstream yet.

This article seeks to provide general mainline Linux development information for the [[PineNote]].

== Mainline development ==

=== Status ===

The following table aims to provide a list of kernel modules required for running the PineNote. It also aims at listing repositories of work in progress. While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]]) is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Module
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver is not mainlineable; it is only needed [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48 (via a hack)] for suspend/resume to work when downstream TF-A is used. Suspend on upstream TF-A ([https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952 status]) should work without any special drivers.
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled. Enabling the <code>gpu</code> node upstream needs to wait till <code>rockchip-ebc</code> is upstreamed.
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

=== Mainlining notes ===

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== Pages discussing the development efforts ==

The software releases can be found here in the future:

* [[PineNote Software Releases]]

The following pages discuss the development efforts for the PineNote:

* [[PineNote Development]]
* [[PineNote Development/Flashing]]
* [[PineNote Development/Booting Linux]]
* [[PineNote Development/Building Kernel]]
* [[PineNote Development/TODOs]]

For tweaks and tricks see:
* [[PineNote Development/Software Tweaks]]

For app development see:
* [[PineNote Development/Apps]]

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

The '''extlinux.conf''' should have the following contents:

timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT

At the U-Boot console, run the following command to boot your mainline kernel:

sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:

mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):

adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:

dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt). The content of the upstream .txt is different than the Android configuration, but is supposed to work.

As you don't have WiFi yet you need to get the ''firmware-brcm80211*.deb'' and ''brcmfmac43455-sdio.txt'' file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the ''bluez-firmware'':

sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===

* https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in ''/sys'' to alter the refresh mode
* https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection

== Further information ==
=== Notes Written by Some Developers ===

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

=== Alternative to patching of mesa ===

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

=== Video of Factory Android OS ===

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge ("adb") over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running <code>adb</code>.

[[Category:PineNote]]

PineNote Development

2023-01-13T22:17:46Z

Diederik: add missing 'when' word

This article seeks to provide general mainline Linux development information for the [[PineNote]].

== Mainline development ==

=== Status ===

The following table aims to provide a list of kernel modules required for running the PineNote. It also aims at listing repositories of work in progress. While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]]) is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Module
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver is not mainlineable; it is only needed [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48 (via a hack)] for suspend/resume to work when downstream TF-A is used. Suspend on upstream TF-A ([https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952 status]) should work without any special drivers.
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled. The <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote wasn't seen yet.
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

=== Mainlining notes ===

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== Pages discussing the development efforts ==

The software releases can be found here in the future:

* [[PineNote Software Releases]]

The following pages discuss the development efforts for the PineNote:

* [[PineNote Development]]
* [[PineNote Development/Flashing]]
* [[PineNote Development/Booting Linux]]
* [[PineNote Development/Building Kernel]]
* [[PineNote Development/TODOs]]

For tweaks and tricks see:
* [[PineNote Development/Software Tweaks]]

For app development see:
* [[PineNote Development/Apps]]

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

The '''extlinux.conf''' should have the following contents:

timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT

At the U-Boot console, run the following command to boot your mainline kernel:

sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:

mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):

adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:

dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt). The content of the upstream .txt is different than the Android configuration, but is supposed to work.

As you don't have WiFi yet you need to get the ''firmware-brcm80211*.deb'' and ''brcmfmac43455-sdio.txt'' file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the ''bluez-firmware'':

sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===

* https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in ''/sys'' to alter the refresh mode
* https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection

== Further information ==
=== Notes Written by Some Developers ===

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

=== Alternative to patching of mesa ===

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

=== Video of Factory Android OS ===

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge ("adb") over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running <code>adb</code>.

[[Category:PineNote]]

PineNote Development

2023-01-13T15:09:07Z

Diederik: Copy link to upstreaming status for TF-A from Q64 dev page into rockchip-set notes

This article seeks to provide general mainline Linux development information for the [[PineNote]].

== Mainline development ==

=== Status ===

The following table aims to provide a list of kernel modules required for running the PineNote. It also aims at listing repositories of work in progress. While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]]) is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Module
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver is not mainlineable; it is only needed (via a hack [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48]) for suspend/resume to work because we are using downstream TF-A. Suspend on upstream TF-A ([https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/16952 status]) should Just Work without any special drivers
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled. The <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote wasn't seen yet.
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

=== Mainlining notes ===

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== Pages discussing the development efforts ==

The software releases can be found here in the future:

* [[PineNote Software Releases]]

The following pages discuss the development efforts for the PineNote:

* [[PineNote Development]]
* [[PineNote Development/Flashing]]
* [[PineNote Development/Booting Linux]]
* [[PineNote Development/Building Kernel]]
* [[PineNote Development/TODOs]]

For tweaks and tricks see:
* [[PineNote Development/Software Tweaks]]

For app development see:
* [[PineNote Development/Apps]]

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

== Further information ==
=== Notes Written by Some Developers ===

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

=== Alternative to patching of mesa ===

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

=== Video of Factory Android OS ===

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge ("adb") over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running <code>adb</code>.

[[Category:PineNote]]

PineNote Development

2023-01-13T14:56:15Z

Diederik: Add more context on non-mainlineable status of rockchip-sip driver

This article seeks to provide general mainline Linux development information for the [[PineNote]].

== Mainline development ==

=== Status ===

The following table aims to provide a list of kernel modules required for running the PineNote. It also aims at listing repositories of work in progress. While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]]) is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Module
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver is not mainlineable; it is only needed (via a hack [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48]) for suspend/resume to work because we are using downstream TF-A. Suspend on upstream TF-A should Just Work without any special drivers
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled. The <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote wasn't seen yet.
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

=== Mainlining notes ===

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== Pages discussing the development efforts ==

The software releases can be found here in the future:

* [[PineNote Software Releases]]

The following pages discuss the development efforts for the PineNote:

* [[PineNote Development]]
* [[PineNote Development/Flashing]]
* [[PineNote Development/Booting Linux]]
* [[PineNote Development/Building Kernel]]
* [[PineNote Development/TODOs]]

For tweaks and tricks see:
* [[PineNote Development/Software Tweaks]]

For app development see:
* [[PineNote Development/Apps]]

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

== Further information ==
=== Notes Written by Some Developers ===

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

=== Alternative to patching of mesa ===

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

=== Video of Factory Android OS ===

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge ("adb") over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running <code>adb</code>.

[[Category:PineNote]]

PineNote Development

2023-01-12T19:58:52Z

Diederik: Moved items from 'Development work' into the table

This article seeks to provide general development information for the [[PineNote]].

= Overview =

== Kernel modules / mainlining status ==

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| The rockchip-sip driver required for suspend/resume is currently only hacked-in [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48]
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
| driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
| WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga].
Note that the rga2e in the rk3566 only works for RAM <= 4 G!).
Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled.
I haven't seen the <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote (yet)?
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

{{Note|This section is wrongly placed, please put it in the corresponding page}}

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

= More Information =
== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

Quartz64 Development

2023-01-12T19:49:41Z

Diederik: Update link to v2 of TRNG patch submission

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 H.263, MPEG-1, 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 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/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>
|
|
|}

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

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

PineNote Development

2023-01-12T19:42:54Z

Diederik: Add link to rockchip-ebc's RFC [PATCH 00/16] drm/rockchip: Rockchip EBC ("E-Book Controller") display driver

This article seeks to provide general development information for the [[PineNote]].

= Overview =

== Kernel modules / mainlining status ==

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-ebc</code>
| [https://lore.kernel.org/all/20220413221916.50995-1-samuel@sholland.org/ RFC PATCH 00/16 drm/rockchip: Rockchip EBC ("E-Book Controller") display driver]
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
|
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
|
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled.
I haven't seen the <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote (yet)?
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

== Development work ==

* tps65185: driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
* RGA: WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga]. Note that the rga2e in the rk3566 only works for RAM <= 4 G!). Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
* The rockchip-sip driver required for suspend/resume is currently only hacked-in [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48]

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

{{Note|This section is wrongly placed, please put it in the corresponding page}}

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

= More Information =
== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

PineNote Development

2023-01-12T19:36:37Z

Diederik: add links to rockchip-sip and ws8100-pen drivers commits

This article seeks to provide general development information for the [[PineNote]].

= Overview =

== Kernel modules / mainlining status ==

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip-sip</code>
| https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
| https://github.com/smaeul/linux/commit/46e87f1f9c7dd22af26d99f60eb83d2cace43cb5
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip_ebc</code>
|
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
|
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
|
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled.
I haven't seen the <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote (yet)?
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

== Development work ==

* tps65185: driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behavior added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
* RGA: WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga]. Note that the rga2e in the rk3566 only works for RAM <= 4 G!). Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
* The rockchip-sip driver required for suspend/resume is currently only hacked-in [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48]

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

{{Note|This section is wrongly placed, please put it in the corresponding page}}

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

= More Information =
== High-level developer new to embedded linux? ==
Here are some resources I have found helpful in learning to develop on embedded linux devices:
* Great youtube series introducing you to the kernel and lower-level components of Linux: https://www.youtube.com/watch?v=WiZ05pnHZqM
* https://embetronicx.com/
* https://bootlin.com/training/
* https://www.nand2tetris.org

== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==

Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files:

* replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
* preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Building the most recent kernel ==
See [[PineNote Development/Building Kernel]].

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

== Emulator for Developing/Testing Pinenote Apps ==
https://github.com/michaelshiel/picom-epaper

PineNote Development

2023-01-12T15:41:46Z

Diederik: Fix rockchip-ebc.patch link ('_' -> '-')

This article seeks to provide general development information for the [[PineNote]]. If you are new and down to try a new installation process, the easiest way to get linux is likely to [https://wiki.pine64.org/wiki/PineNote_Development/Installing_Debian install Debian] -- NOTE THAT THIS INSTALLATION PROCESS IS VERY NEW. While many people have been using the kernel that will be installed safely at this point, the instructions for installing Debian via rootfs are very new. Take backups!

The more stable recommended approach is described below:

Start with [https://github.com/DorianRudolph/pinenotes Dorian's guide] which will guide you through getting Arch installed. For instructions on building the latest kernel, see [[PineNote Development/Building Kernel]]. For helpful configurations, see [[PineNote Development/Apps]]. For ways to pitch in, see [[PineNote Development/TODOs]]. To boot Linux by default instead of Android, see [[PineNote Development/Booting Linux]]. [https://www.youtube.com/watch?v=ZCLyJfbzbrU Here is a video] of a user running Manjaro and some apps on their PineNote on 9/10/2022.

= Overview =

== Kernel modules / mainlining status ==

WORK IN PROGRESS !

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Suspend mode driver
| colspan="2" style="text-align:center;"|tbd
|<code>rockchip-sip</code>
|
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
|
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip_ebc</code>
|
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
|
|-
| LED backlight driver
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>st-accel-i2c</code> (silan,sc7a20)
| As of 5.18-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=cc6ce5ac2c998d7e869d7289736e0097ce7d2ad1]
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
|
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled.
I haven't seen the <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote (yet)?
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

==== Development work ====

* tps65185: driver developed here: [https://github.com/smaeul/linux/tree/rk35/tps65185], small tweaks to resume behaviour added on top here: [https://github.com/m-weigand/linux/commits/mw/rk35/tps65185]
* RGA: WIP patches for activation on the Pinenote/dithering/Y4-conversion can be found here: [https://github.com/m-weigand/linux/commits/mw/rk35/rk356x-rga]. Note that the rga2e in the rk3566 only works for RAM <= 4 G!). Simple demo program found here: [https://github.com/m-weigand/rga-v4l2-demo]
* The rockchip-sip driver required for suspend/resume is currently only hacked-in [https://github.com/smaeul/linux/commit/72127ca2806623a9de52cc1de39b06a38a22fe48]

= More Information =
== High-level developer new to embedded linux? ==
Here are some resources I have found helpful in learning to develop on embedded linux devices:
* Great youtube series introducing you to the kernel and lower-level components of Linux: https://www.youtube.com/watch?v=WiZ05pnHZqM
* https://embetronicx.com/
* https://bootlin.com/training/
* https://www.nand2tetris.org

== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip-ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==
Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files: 
- replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
- preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Building the most recent kernel ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel here].

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

== Emulator for Developing/Testing Pinenote Apps ==
https://github.com/michaelshiel/picom-epaper

= Flashing Software =
Currently, the only ways to flash software are from the factory Android installation (UART shell, adb, or fastboot) or by using rkdeveloptool.

== Backup of the content of the internal MMC before you mess anything up ==
Especially the '''waveform''' partition contains data '''unique''' to your PineNote and is a prime candidate for backup.

But other partitions like uboot (need for any operation of the device) or the un-partitioned space at the beginning containing the GPT partition table (and presumably the VCOM setting for the e-ink display and maybe device mac addresses) contains data you may wish to backup.

Depending of your personal level of data hoarder you may want to backup more than this or even just everything (the large userdata partition is supposed to be able to be repopulated as empty space by Android)

In any case it is easier to restore/extract data from a backup than not having one if you need one.

=== Manually using rkdeveloptool ===
Dorian has some nice [https://github.com/DorianRudolph/pinenotes notes regarding the PineNote]

Don't forget to install a patched uboot for reading beyond 32MB and to respect the 2GB limit/bug of the current rkdeveloptool as per his notes

=== Automated backup using a script and rkdeveloptool ===
[https://github.com/talpadk/pinenote-backup pinenote-backup] is a python script for detecting the partitions and automating the backup of partitions or the whole disk

I also requires a patched u-boot but automatically handles the 2GB limit by splitting up larger reads into smaller ones

=== Using the factory Android installation ===
For any one knowing how and with which caveats: Write ME

=== Using a user installed Linux ===
A Linux installed to the cache partition should be able to easily backup everything over WiFi or to a USB stick/disk using dd

However the user would need to backup the cache partition themself (if they want that).

And more importantly they would only be getting the backup ''after'' they started playing with the content of the MMC.

== Side-by-side setup ==

It is possible to set up a partition for mainline development without disturbing the factory Android installation. This allows updating a mainline kernel, DTB, and initramfs over Wi-Fi until WiFi or USB OTG is working in mainline Linux.

=== Without Repartitioning ===

The recommended partition for this is <tt>mmcblk0p11</tt> aka <tt>/cache</tt>. It is large and already formatted as <tt>ext4</tt>, so it is readable from U-Boot. Here are some general steps:

# From the UART or adb shell, set up your chroot in <tt>/cache</tt>. I used the Alpine Linux rootfs tarball.
# Copy in your kernel and DTB, using for example <tt>scp</tt> or <tt>wget</tt> inside the chroot.
# Finally, create and boot an <code>extlinux.conf</code> as described below.

=== With Repartitioning ===

It is possible to shrink the <tt>userdata</tt> partition, and create a new partition at the end for use with mainline Linux. This provides much more space than <tt>cache</tt>. However, because <tt>userdata</tt> is formatted with <tt>f2fs</tt>, and that filesystem cannot be shrunk, resizing the partition requires wiping <tt>userdata</tt>.

# Back up any necessary files from userdata
# Boot to a mainline kernel from <tt>mmcblk0p11</tt>, either using that partition as rootfs (see above), or using an initramfs with repartitioning tools
# Modify the partition table with your favorite tool, e.g. <tt>fdisk</tt>, <tt>gdisk</tt>, or <tt>parted</tt>
# Reboot into <tt>fastboot</tt> and wipe <tt>userdata</tt>.
# Reboot into Android, where you can now chroot in and install your favorite distribution to the new partition.

== Using rkdeveloptool ==

rkdeveloptool is a command line utility built on libusb.

=== Downloading and Building rkdeveloptool ===

PINE64 develops [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool its own updated fork of rkdeveloptool on GitLab].

You will need to have libusb 1.0, its development headers and scdoc installed.

<pre>
git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git
cd rkdeveloptool
mkdir build
cd build
cmake ..
</pre>

This sets up all the build files. You can then compile with <code>make</code> inside the build directory.

After you're done, you'll likely also need to install the udev rules, or else your user won't have permission to access the USB devices:

<pre>
sudo cp 99-rk-rockusb.rules /etc/udev/rules.d/
sudo udevadm control --reload
</pre>

Copying the udev rules is also performed automatically when you <code>make install</code>.

=== Building Downstream U-Boot ===

While in maskrom mode, we need to have a u-boot to download onto the device for any of the other commands to work. To build you'll also need to install device-tree-compiler.

You also need to install Python and pyelftools.

 Note that rkbin is a >5GB download! This will take some time to clone and process the deltas.

<pre>
git clone -b quartz64 https://gitlab.com/pgwipeout/u-boot-rockchip.git
git clone -b rkbin https://github.com/JeffyCN/rockchip_mirrors.git rkbin
cd u-boot-rockchip
# If using Arch Linux, export CROSS_COMPILE=aarch64-linux-gnu-
export CROSS_COMPILE=aarch64-none-linux-gnu-
make rk3566-quartz64_defconfig
./make.sh
</pre>

<blockquote>
In the version I cloned (current as of 2022-01-02), I had to make a change to one line to get a clean compilation:

<pre>
diff --git a/lib/avb/libavb/avb_slot_verify.c b/lib/avb/libavb/avb_slot_verify.c
index 123701fc3b..64a1ce6450 100644
--- a/lib/avb/libavb/avb_slot_verify.c
+++ b/lib/avb/libavb/avb_slot_verify.c
@@ -296,7 +296,7 @@ static AvbSlotVerifyResult load_and_verify_hash_partition(
bool image_preloaded = false;
uint8_t* digest;
size_t digest_len;
- const char* found;
+ const char* found = NULL;
uint64_t image_size;
size_t expected_digest_len = 0;
uint8_t expected_digest_buf[AVB_SHA512_DIGEST_SIZE];
</pre>

For systems where the global python executable points to python2, compilation fails with an error related to pyelftools not being installed (even if it is). To fix this:
<pre>
diff --git a/make.sh b/make.sh
index 2bba05b4e4..cfe5b0afd5 100755
--- a/make.sh
+++ b/make.sh
@@ -758,7 +758,7 @@ function pack_fit_image()
fi

if [ "${ARM64_TRUSTZONE}" == "y" ]; then
- if ! python -c "import elftools" ; then
+ if ! python3 -c "import elftools" ; then
echo "ERROR: No python 'pyelftools', please: pip install pyelftools"
exit 1
fi
</pre>
</blockquote>

=== Entering Maskrom/Rockusb Mode ===

There are three ways to get into Maskrom/Rockusb mode:

==== The easy way ====

# Flip the device around so that the display faces down
# Lay the pen on the right side, with its tip pointing towards the speaker grill, and its magnet pointing towards the upper right corner of the label on the back (or place the magnetic cap from the pen on the spot marked on the back).
# Turn the device on and wait for it to show up in <code>lsusb</code>. It should now be in Loader mode, according to <code>rkdeveloptool list-devices</code> (note that "Loader" here indicates U-Boot's Rockusb; separately, booting with an erased eMMC displays "Maskrom" [not "Loader"] from the RK3566).
# Unplug the device and plug it back in. It should now be in Rockusb mode.

This can be a bit fiddly to get right, and may need a few tries.

==== The u-boot way ====
# Interrupt the u-boot startup using ctrl-c (while attached using an UART dongle)
# While in u-boot use the command "rockusb 0 mmc 0" to start rockusb mode.

One benefit from this is, that if you have an UART dongle that allows to simultaneous having an UART and USB connection, there is no need to plug and unplug cables and flipping the PineNote around and placing magnets.

This is especially helpful when changing back and forth between u-boot and rockusb, for instance when trying to develop u-boot.

==== Shorting test points ====

If the bootloader is broken/corrupted, you cannot get to Maskrom without opening up the device (it can be opened using spudger and a bit of patience).

Once inside, short TP1301 (GND) and TP1302 (eMMC_D0/FLASH_D0) with a small tweezers, this is how it looks on board view (credit to Caleb):

[[File:PineNote_Maskrom_TP.png|500px]]

Then plug the device to the computer and if you see the device with VID=2207/PID=350a then it should be in Maskrom mode, you can verify by typing <code>rkdeveloptool list-devices</code>.

<nowiki>Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device found, idVendor=2207, idProduct=350a, bcdDevice= 1.00
Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device strings: Mfr=0, Product=0, SerialNumber=0

$ rkdeveloptool list-devices
DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom</nowiki>

If nothing shows up, you can try to hold down the power button for 5 seconds and then try again.

=== Running rkdeveloptool ===

First, you'll want to make sure the device you've connected is in maskrom mode:

<pre>
./rkdeveloptool list
</pre>

It should output something like <code>DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=202 Maskrom</code>. If it doesn't, see [[PineNote Development#Entering Maskrom Mode]].

You can now download u-boot onto it:
<pre>
./rkdeveloptool boot ../u-boot-rockchip/rk356x_spl_loader_v1.08.111.bin
</pre>

This should output <code>Downloading bootloader succeeded.</code>.

We can now verify that this worked using e.g. the "read flash info" command:

<pre>
./rkdeveloptool read-flash-info
</pre>

'''TODO:''' finish this section

=== Creating a mainline boot image ===

You can create a filesystem image that replaces the Android boot or recovery partition by doing roughly the following:

# Erase boot and dtbo with rkdeveloptool or fastboot (back them up first!!!)
# Create an ext2 partition image and mount it (fallocate, mkfs.ext2)
# Build your mainline kernel
# Copy the kernel, dtb and an initramfs to the root of the mounted image (use any old postmarketOS initramfs)
# Create a file in the root of the mounted image called <code>extlinux.conf</code> as described below
# Unmount the image and then use rkdeveloptool to flash it to the "recovery" partition on the pinenote (it's about the right size until we get around to replacing the partition layout).

== Using fastboot ==

Follow the steps for "Creating a mainline boot.img", but instead of flashing it with rkdeveloptool, use fastboot. You can enter fastboot in either of two ways:

# Use "reboot bootloader" from adb or a UART console.
# Get a U-Boot prompt and run <code>fastboot usb 0</code>.

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

Quartz64

2023-01-11T18:19:40Z

Diederik: Link to Plebian images as that uses the Debian kernel and that works. No need to compile one yourself.

[[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|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, as some images' u-boot may have no video output on this chip.}}
{{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.

=== Plebian ===

Plebian stands for '''P'''INE64 '''L'''ive D'''ebian''' and aims to be a fairly vanilla live Debian image for Quartz64 and SOQuartz devices, based on Debian Bookworm.

* [https://github.com/Plebian-Linux/quartz64-images/releases Download Release Images]
* [https://github.com/Plebian-Linux/quartz64-images/blob/main/RUNNING.md Read The Instructions]

To flash, run (replace <tt>/dev/sdX</tt> with your target block device):

$ xzcat imagename.img.xz | sudo dd of=/dev/sdX bs=4M oflag=dsync status=progress

Some quick notes:

* You will be asked to change your password on first login (for what the default login is, read the instructions!)
* Root file system is grown to take up the entire space of your boot device
* NetworkManager is used instead of Debian's interfaces config to be more flexible with what adapters are plugged in and working
* An sshd is started on port 22 with freshly generated keys

== 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 ''[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" 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.

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

== 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 (<tt>stress-ng -c4</tt>). Model A will be similar as it's the same SoC.

[[Category:Quartz64]]

Quartz64 Development

2023-01-11T17:59:36Z

Diederik: Apart from u-boot, Plebian (https://wiki.pine64.org/wiki/Quartz64#Plebian) is built entirely from Debian, so remove the OS_Images section from the TODO

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 H.263, MPEG-1, 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 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/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=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.

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

PineNote

2023-01-11T08:22:15Z

Diederik: Add link to PineNote development page

[[File:PineNote-1.jpg|400px|thumb|right|The PineNote]]

The PineNote is the first hybrid notepad computer device combination of notebook, tablet and e-reader using an e-ink panel. It is derived from the Quartz64 model A SBC and powered by a Rockchip RK3566 quad-core ARM Cortex A55 64-bit processor with a MALI G-52 GPU.

== Introduction ==

=== State of the software ===

The PineNote is based on the in 2021 released Rockchip RK3566 SoC. The upstreaming status of the SoC functionality can be found on the [[Quartz64 Development#Upstreaming Status|Quartz64 development]] wiki page of the Quartz64 single-board computer using the same SoC. In the [[PineNote_Development#Kernel_modules_/_mainlining_status|PineNote development]] wiki page you'll find the items specific for the PineNote.

The early adopter's batch of the PineNote is aimed solely at early adopters - more specifically, the units are solely intended to find their way into the hands of users with extensive Linux experience. If you’re looking to buy a PineNote in the first batch, you must expect to write software for it, not to write notes on it. The software shipping from the factory for the first batch will not be suitable for taking notes, reading e-books, or writing your dissertation. It may not even boot to a graphical environment.

An early version of a GNOME-based Debian image is available for [[PineNote_Development/Installing_Debian|testing]], but should not be expected to meet general-user readiness.

=== Help and support ===

Still have any questions regarding software, shipping, or ordering after reading this wiki? Please don't hesitate to contact the community in the bridged community channels for detailed answers or simply to chat with friendly people in the community! See [[Main Page#Community and Support]].

Please keep in mind that PINE64 is not like a regular company (see the [https://www.pine64.org/philosophy/ PINE64 philosophy]) and that support resources are limited - the best way to get support quickly is to ask in the community chat! Please only contact the PINE64 support directly if questions couldn't be solved via the community chat or this wiki.

== Specification ==
[[File:PineNote_Pen_function.jpg|300px|right]]
[[File:PineNote_Cover-1.jpg|300px|right]]

=== General Information ===
* Dimensions: 191.1x232.5x7.4mm
* Weight: 438g

=== Core ===
* CPU: RK3566 1.8GHz 64-bit quad-core A55
* GPU: MALI G52 2EE
* System memory: 4GB LPDDR4
* Flash: 128GB eMMC

=== E-ink Display ===
* Size: 10.3"
* Resolution: 1404x1872
* DPI: 227
* Grayscale: 16
* Front Light: 36 level cold and warm
* Capacitive multi-touch panel
* EMR pen digitizer

=== Network ===
* WiFi: 2.4/5GHz 802.11a/b/g/n/ac
* Bluetooth: 5.0

=== Audio ===
* Built in stereo speakers
* 4 x DMIC microphone

=== Sensor ===
* G-Sensor for portrait and landscape sensing

=== Power ===
* 4000mAH LiPo battery
* DC 5V @ 3A USB-C connector

=== Accessories ===
* Optional EMR pen with magnetic attachment (included in the first production batch)
* Optional Cover (included in the first production batch)

== Software releases ==
* Not yet available

== 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 : 4GB LPDDR4.
* Flash Memory: 128GB eMMC

== PineNote Information, Schematics, and Certifications ==
* PineNote Developer kit version
* The v1.2 is the PineNote production schematic.
** [https://files.pine64.org/doc/PineNote/PINENOTE_MAIN-V1R2%20-%20Schematic-20210824.pdf PineNote Mainboard Schematic ver 1.2 20210824 PDF file]
** [https://files.pine64.org/doc/PineNote/PINENOTE_USB-C-Board-V1.0-sch.pdf PineNote USB-C Daughter Board Schematic ver 1.0 PDF file]
** [https://files.pine64.org/doc/PineNote/PineNote_USB-C_Console_UART_breakout_board_schematic_v1.0_20210903.pdf PineNote USB-C Console UART Breakout Board Schematic ver 1.0 PDF file]
* The v1.1 is early release schematic just for reference only and used by developers who received the prototype.
** [https://files.pine64.org/doc/PineNote/PINENOTE_MAIN-V1R1%20-%20Schematic-20210726.pdf PineNote early released Schematic ver 1.1 20210726 PDF file]
** [https://files.pine64.org/doc/PineNote/PINENOTE_MAIN-V1R1-REF-TOP-20210726.pdf PineNote early released ver 1.1 20210726 PCB Connector placement PDF file]

* Certifications:
** [https://files.pine64.org/doc/cert/PineNote%20FCC15C%20Certificate%20DTS-TC561262.pdf PineNote FCC-15C Certificate]
** [https://files.pine64.org/doc/cert/PineNote%20FCC15E%20Certificate%20NII-TC973072.pdf PineNote FCC-15E Certificate]
** [https://files.pine64.org/doc/cert/PineNote%20CE%20RED%20Certicate%20ET-21090682EC.pdf PineNote CE RED Certificate]
** [https://files.pine64.org/doc/cert/PineNote%20RoHS%20Certificate%20ET-210900082C.pdf PineNote ROHS 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]
* Rockchip RK817 PMU (Power Management Unit) Information:
** [https://www.rockchip.fr/RK817%20datasheet%20V1.01.pdf Rockchip RK817 ver 1.01 datasheet]
* LPDDR4 (200 Balls) SDRAM:
** ---
* eMMC information:
** [https://en.biwin.com.cn/product/detail/6 Biwin 128GB eMMC model: BWCTASC41P128G]
* E-ink Panel information:
** [https://files.pine64.org/doc/quartz64/Eink%20P-511-828-V1_ED103TC2%20Formal%20Spec%20V1.0_20190514.pdf E-Ink 10.3" 1872x1404 ED103TC2 Glass Panel Specification]
** [https://files.pine64.org/doc/datasheet/PineNote/TI%20PMU-TPS651851.pdf TPS65185x PMIC for E-Ink Enabled Electronic Paper Display Datasheet]
* Touch Screen information:
** [https://files.pine64.org/doc/datasheet/PineNote/CYTMA448_Summary_RevC_5-26-16.pdf Cypress CYTMA448 multi-Point Capacitive Touch Controller Datasheet]
** Wacom Pen Digitizer Unit Model: SUDE-10S15MI-01X for 10.3" Display Module
* 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]]
* G Sensor info:
** [http://www.silan.com.cn/en/product/details/47.html#app01 Silan SC7A20 3-Axis MEMS Accelerometer]
* Audio Amplifier information:
** [https://files.pine64.org/doc/datasheet/PineNote/Awinic%20AW87318%20Class-K%20Audio%20Amp%20Datasheet.pdf Awinic AW87318 Class-K Audio Amp Datasheet]

== Development Efforts ==

* [[PineNote Development]] for general information regarding how to flash the device and other development information.

=== Software ===

* [[Quartz64 Development]] for the mainlining status of various functions on the Rockchip RK3566 SoC.
* [[RK3566 EBC Reverse-Engineering]] for the EBC (eInk Panel) driver.

=== Hardware ===

This section includes discussions and their results regarding hardware changes to the PineNote.

The following topics have resolved:

* [[PineNote/Hardware_Changes/Closed_Case_UART]]
* '''Could the USB-C port support USB 3.1 5Gbps?''' Yes and no. The RK3566 only has a host-mode 5Gbps controller, meaning it can only negotiate such a high data rate with a device such as a flash drive. When the RK3566 is acting as a device, it only supports 480Mbps transfer rates. The hardware required to switch between these modes would raise the PineNote's price unreasonably. Therefore, the USB-C port will remain at USB 2.0 speeds for Host and Device mode.
* '''Could the USB-C port output DisplayPort?''' Yes and no. The hardware required to support such a feature would raise the PineNote's price unreasonably. Therefore, DisplayPort output will not be possible through the USB-C port.
* '''Where is the microSD card slot?''' The case design of the PineNote is fixed, making physical changes like adding a microSD card slot would raise the cost unreasonably.
* '''How will I install software to the PineNote?''' This is a hardware and software question. If the software on your PineNote is completely broken and cannot boot to a recoverable state, a Hall (magnet) sensor was fitted to the PineTab motherboard as U9009. This sensor is attached to SARADC_VIN0_KEY/RECOVERY on the RK3566. With the device powered off, and screen face down, holding a magnet over U9009 and plugging in a USB-C cable causes the device to boot into [http://opensource.rock-chips.com/wiki_Rockusb "rockusb"] flash mode. With proper flashing software and drivers, it should be possible to load a new operating system using rockusb if the system is soft-bricked. Of course, software vendors will need to be more careful with flashing firmware and providing useful "recovery" options on this device due to this process's relative difficulty to other PINE64 devices.

==== Unresolved ====

The following concerns have been brought up as open, unanswered topics:

* Does [https://en.wikipedia.org/wiki/USB-C#Audio_Adapter_Accessory_Mode_2|USB-C Audio Adapter Accessory Mode] work? It appears that the Headphone output of the audio codec was routed to the USB-C audio+USB switch, but it's unclear whether CC lines are hooked up correctly for detection of such a device. The PineNote hardware team will be testing this functionality soon (as of August 19, 2021). Note that Audio Accessory mode is detectable by reading the I2C registers of the WUSB3801Q. So connecting ASEL to a GPIO would be enough to get this working if it is not working already.
* Why is the Headphone output of the audio codec routed to the speakers? HPL_OUT is routed from the RK817 PMIC and audio codec to U9010 (the USB-C switch) and U6 (the audio amplifier). SPK_OUT is unused. It seems like SPK_OUT should be routed to U6 and HPL_OUT to U9010.
* Nitpick: The cold white charging LED bleeds through the gap between the rear case and the device's face. It does not bleed onto the screen, but it is jarring in low-light conditions or when the screen is amber. Could be resolved in software by turning off the charge LED when the screen is on.
* Is there any way to indicate when the device is in rockusb mode, such as connecting a certain magic pin to the power LED?
* The modem/4G connector (J6010) has its I2C and UART pins unconnected. Could those be connected to the SoC?

==== USB-C Debug Accesory Mode (DAM)/UART Dongle====
The USB UART dongle delivered with the PineNote allows you to have access to a serial port without having to open up the device. The factory firmware runs at a baud rate of 1500000bps, 8 data bits 1 stop bit, no parity and no flow control. The USB-C male end should go into the PineNote and the female end can be connected with a standard USB-C cable to your computer.

=== Documentation ===
PineNote development documentation is a little lacking. Unless you are relatively plugged in with the chat, it's difficult to know what is going on. There is an effort to amend that that lives here: [[PineNote Documentation]].

== BSP Linux SDK ==

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

== Android SDK ==

=== Android 11 eink SDK for PineNote and Quart64 model A SBC ===
* This 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]
** [https://tmp.mwfc.info/pinenote/QUARTZ64-model-A_eink.android11_SDK.tar.gz mirror by mwfc]
** MD5 (TAR-GZip file): 293a550584298de4fb95ceae18103672
** File Size: 72.88GB
** Just the boot blobs (<1MB): [[File:Rk35-blobs.tar.gz]]
* View [[Android SDK for RK3566]] for more information how to compile an image for the PineNote using this SDK

== Torrent ==
There is a [https://cdn.discordapp.com/attachments/870707390998282292/907726420204208148/pinenote.torrent torrent] with the files (100GB)

== Hardware troubleshooting guide ==
At present, nothing is available.

[[Category:PineNote]] [[Category:Rockchip RK3566]]

PineNote Development

2023-01-11T08:09:45Z

Diederik: Updated status for panfrost wrt PineNote as I think it's not yet enabled *for* PineNote

This article seeks to provide general development information for the [[PineNote]]. If you are new and down to try a new installation process, the easiest way to get linux is likely to [https://wiki.pine64.org/wiki/PineNote_Development/Installing_Debian install Debian] -- NOTE THAT THIS INSTALLATION PROCESS IS VERY NEW. While many people have been using the kernel that will be installed safely at this point, the instructions for installing Debian via rootfs are very new. Take backups!

The more stable recommended approach is described below:

Start with [https://github.com/DorianRudolph/pinenotes Dorian's guide] which will guide you through getting Arch installed. For instructions on building the latest kernel, see [[PineNote Development/Building Kernel]]. For helpful configurations, see [[PineNote Development/Apps]]. For ways to pitch in, see [[PineNote Development/TODOs]]. To boot Linux by default instead of Android, see [[PineNote Development/Booting Linux]]. [https://www.youtube.com/watch?v=ZCLyJfbzbrU Here is a video] of a user running Manjaro and some apps on their PineNote on 9/10/2022.

= Overview =

== Kernel modules / mainlining status ==

WORK IN PROGRESS !

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
|
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip_ebc</code>
|
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
|
|-
| LED backlight driver
| colspan="2" style="text-align:center;"|tbd
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="text-align:center;"|tbd
| <code>st-accel-i2c</code>
|
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
|
|-
| Mali GPU
| style="background:LightYellow; 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] this got added to the <code>.dtsi</code> file, but it's status is disabled.
I haven't seen the <code>gpu</code> node getting enabled in the <code>.dts</code> for PineNote (yet)?
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

= More Information =
== High-level developer new to embedded linux? ==
Here are some resources I have found helpful in learning to develop on embedded linux devices:
* Great youtube series introducing you to the kernel and lower-level components of Linux: https://www.youtube.com/watch?v=WiZ05pnHZqM
* https://embetronicx.com/
* https://bootlin.com/training/
* https://www.nand2tetris.org

== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip_ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==
Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files: 
- replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
- preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Building the most recent kernel ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel here].

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

== Emulator for Developing/Testing Pinenote Apps ==
https://github.com/michaelshiel/picom-epaper

= Flashing Software =
Currently, the only ways to flash software are from the factory Android installation (UART shell, adb, or fastboot) or by using rkdeveloptool.

== Backup of the content of the internal MMC before you mess anything up ==
Especially the '''waveform''' partition contains data '''unique''' to your PineNote and is a prime candidate for backup.

But other partitions like uboot (need for any operation of the device) or the un-partitioned space at the beginning containing the GPT partition table (and presumably the VCOM setting for the e-ink display and maybe device mac addresses) contains data you may wish to backup.

Depending of your personal level of data hoarder you may want to backup more than this or even just everything (the large userdata partition is supposed to be able to be repopulated as empty space by Android)

In any case it is easier to restore/extract data from a backup than not having one if you need one.

=== Manually using rkdeveloptool ===
Dorian has some nice [https://github.com/DorianRudolph/pinenotes notes regarding the PineNote]

Don't forget to install a patched uboot for reading beyond 32MB and to respect the 2GB limit/bug of the current rkdeveloptool as per his notes

=== Automated backup using a script and rkdeveloptool ===
[https://github.com/talpadk/pinenote-backup pinenote-backup] is a python script for detecting the partitions and automating the backup of partitions or the whole disk

I also requires a patched u-boot but automatically handles the 2GB limit by splitting up larger reads into smaller ones

=== Using the factory Android installation ===
For any one knowing how and with which caveats: Write ME

=== Using a user installed Linux ===
A Linux installed to the cache partition should be able to easily backup everything over WiFi or to a USB stick/disk using dd

However the user would need to backup the cache partition themself (if they want that).

And more importantly they would only be getting the backup ''after'' they started playing with the content of the MMC.

== Side-by-side setup ==

It is possible to set up a partition for mainline development without disturbing the factory Android installation. This allows updating a mainline kernel, DTB, and initramfs over Wi-Fi until WiFi or USB OTG is working in mainline Linux.

=== Without Repartitioning ===

The recommended partition for this is <tt>mmcblk0p11</tt> aka <tt>/cache</tt>. It is large and already formatted as <tt>ext4</tt>, so it is readable from U-Boot. Here are some general steps:

# From the UART or adb shell, set up your chroot in <tt>/cache</tt>. I used the Alpine Linux rootfs tarball.
# Copy in your kernel and DTB, using for example <tt>scp</tt> or <tt>wget</tt> inside the chroot.
# Finally, create and boot an <code>extlinux.conf</code> as described below.

=== With Repartitioning ===

It is possible to shrink the <tt>userdata</tt> partition, and create a new partition at the end for use with mainline Linux. This provides much more space than <tt>cache</tt>. However, because <tt>userdata</tt> is formatted with <tt>f2fs</tt>, and that filesystem cannot be shrunk, resizing the partition requires wiping <tt>userdata</tt>.

# Back up any necessary files from userdata
# Boot to a mainline kernel from <tt>mmcblk0p11</tt>, either using that partition as rootfs (see above), or using an initramfs with repartitioning tools
# Modify the partition table with your favorite tool, e.g. <tt>fdisk</tt>, <tt>gdisk</tt>, or <tt>parted</tt>
# Reboot into <tt>fastboot</tt> and wipe <tt>userdata</tt>.
# Reboot into Android, where you can now chroot in and install your favorite distribution to the new partition.

== Using rkdeveloptool ==

rkdeveloptool is a command line utility built on libusb.

=== Downloading and Building rkdeveloptool ===

PINE64 develops [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool its own updated fork of rkdeveloptool on GitLab].

You will need to have libusb 1.0, its development headers and scdoc installed.

<pre>
git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git
cd rkdeveloptool
mkdir build
cd build
cmake ..
</pre>

This sets up all the build files. You can then compile with <code>make</code> inside the build directory.

After you're done, you'll likely also need to install the udev rules, or else your user won't have permission to access the USB devices:

<pre>
sudo cp 99-rk-rockusb.rules /etc/udev/rules.d/
sudo udevadm control --reload
</pre>

Copying the udev rules is also performed automatically when you <code>make install</code>.

=== Building Downstream U-Boot ===

While in maskrom mode, we need to have a u-boot to download onto the device for any of the other commands to work. To build you'll also need to install device-tree-compiler.

You also need to install Python and pyelftools.

 Note that rkbin is a >5GB download! This will take some time to clone and process the deltas.

<pre>
git clone -b quartz64 https://gitlab.com/pgwipeout/u-boot-rockchip.git
git clone -b rkbin https://github.com/JeffyCN/rockchip_mirrors.git rkbin
cd u-boot-rockchip
# If using Arch Linux, export CROSS_COMPILE=aarch64-linux-gnu-
export CROSS_COMPILE=aarch64-none-linux-gnu-
make rk3566-quartz64_defconfig
./make.sh
</pre>

<blockquote>
In the version I cloned (current as of 2022-01-02), I had to make a change to one line to get a clean compilation:

<pre>
diff --git a/lib/avb/libavb/avb_slot_verify.c b/lib/avb/libavb/avb_slot_verify.c
index 123701fc3b..64a1ce6450 100644
--- a/lib/avb/libavb/avb_slot_verify.c
+++ b/lib/avb/libavb/avb_slot_verify.c
@@ -296,7 +296,7 @@ static AvbSlotVerifyResult load_and_verify_hash_partition(
bool image_preloaded = false;
uint8_t* digest;
size_t digest_len;
- const char* found;
+ const char* found = NULL;
uint64_t image_size;
size_t expected_digest_len = 0;
uint8_t expected_digest_buf[AVB_SHA512_DIGEST_SIZE];
</pre>

For systems where the global python executable points to python2, compilation fails with an error related to pyelftools not being installed (even if it is). To fix this:
<pre>
diff --git a/make.sh b/make.sh
index 2bba05b4e4..cfe5b0afd5 100755
--- a/make.sh
+++ b/make.sh
@@ -758,7 +758,7 @@ function pack_fit_image()
fi

if [ "${ARM64_TRUSTZONE}" == "y" ]; then
- if ! python -c "import elftools" ; then
+ if ! python3 -c "import elftools" ; then
echo "ERROR: No python 'pyelftools', please: pip install pyelftools"
exit 1
fi
</pre>
</blockquote>

=== Entering Maskrom/Rockusb Mode ===

There are three ways to get into Maskrom/Rockusb mode:

==== The easy way ====

# Flip the device around so that the display faces down
# Lay the pen on the right side, with its tip pointing towards the speaker grill, and its magnet pointing towards the upper right corner of the label on the back (or place the magnetic cap from the pen on the spot marked on the back).
# Turn the device on and wait for it to show up in <code>lsusb</code>. It should now be in Loader mode, according to <code>rkdeveloptool list-devices</code> (note that "Loader" here indicates U-Boot's Rockusb; separately, booting with an erased eMMC displays "Maskrom" [not "Loader"] from the RK3566).
# Unplug the device and plug it back in. It should now be in Rockusb mode.

This can be a bit fiddly to get right, and may need a few tries.

==== The u-boot way ====
# Interrupt the u-boot startup using ctrl-c (while attached using an UART dongle)
# While in u-boot use the command "rockusb 0 mmc 0" to start rockusb mode.

One benefit from this is, that if you have an UART dongle that allows to simultaneous having an UART and USB connection, there is no need to plug and unplug cables and flipping the PineNote around and placing magnets.

This is especially helpful when changing back and forth between u-boot and rockusb, for instance when trying to develop u-boot.

==== Shorting test points ====

If the bootloader is broken/corrupted, you cannot get to Maskrom without opening up the device (it can be opened using spudger and a bit of patience).

Once inside, short TP1301 (GND) and TP1302 (eMMC_D0/FLASH_D0) with a small tweezers, this is how it looks on board view (credit to Caleb):

[[File:PineNote_Maskrom_TP.png|500px]]

Then plug the device to the computer and if you see the device with VID=2207/PID=350a then it should be in Maskrom mode, you can verify by typing <code>rkdeveloptool list-devices</code>.

<nowiki>Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device found, idVendor=2207, idProduct=350a, bcdDevice= 1.00
Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device strings: Mfr=0, Product=0, SerialNumber=0

$ rkdeveloptool list-devices
DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom</nowiki>

If nothing shows up, you can try to hold down the power button for 5 seconds and then try again.

=== Running rkdeveloptool ===

First, you'll want to make sure the device you've connected is in maskrom mode:

<pre>
./rkdeveloptool list
</pre>

It should output something like <code>DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=202 Maskrom</code>. If it doesn't, see [[PineNote Development#Entering Maskrom Mode]].

You can now download u-boot onto it:
<pre>
./rkdeveloptool boot ../u-boot-rockchip/rk356x_spl_loader_v1.08.111.bin
</pre>

This should output <code>Downloading bootloader succeeded.</code>.

We can now verify that this worked using e.g. the "read flash info" command:

<pre>
./rkdeveloptool read-flash-info
</pre>

'''TODO:''' finish this section

=== Creating a mainline boot image ===

You can create a filesystem image that replaces the Android boot or recovery partition by doing roughly the following:

# Erase boot and dtbo with rkdeveloptool or fastboot (back them up first!!!)
# Create an ext2 partition image and mount it (fallocate, mkfs.ext2)
# Build your mainline kernel
# Copy the kernel, dtb and an initramfs to the root of the mounted image (use any old postmarketOS initramfs)
# Create a file in the root of the mounted image called <code>extlinux.conf</code> as described below
# Unmount the image and then use rkdeveloptool to flash it to the "recovery" partition on the pinenote (it's about the right size until we get around to replacing the partition layout).

== Using fastboot ==

Follow the steps for "Creating a mainline boot.img", but instead of flashing it with rkdeveloptool, use fastboot. You can enter fastboot in either of two ways:

# Use "reboot bootloader" from adb or a UART console.
# Get a U-Boot prompt and run <code>fastboot usb 0</code>.

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

Quartz64 Development

2023-01-10T15:54:51Z

Diederik: Shorten URLs to commits in Linus Torvalds repo

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 H.263, MPEG-1, 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 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/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=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]]

PineNote Development

2023-01-10T15:44:07Z

Diederik: minor formatting fixes, mostly 'code' tag around component name

This article seeks to provide general development information for the [[PineNote]]. If you are new and down to try a new installation process, the easiest way to get linux is likely to [https://wiki.pine64.org/wiki/PineNote_Development/Installing_Debian install Debian] -- NOTE THAT THIS INSTALLATION PROCESS IS VERY NEW. While many people have been using the kernel that will be installed safely at this point, the instructions for installing Debian via rootfs are very new. Take backups!

The more stable recommended approach is described below:

Start with [https://github.com/DorianRudolph/pinenotes Dorian's guide] which will guide you through getting Arch installed. For instructions on building the latest kernel, see [[PineNote Development/Building Kernel]]. For helpful configurations, see [[PineNote Development/Apps]]. For ways to pitch in, see [[PineNote Development/TODOs]]. To boot Linux by default instead of Android, see [[PineNote Development/Booting Linux]]. [https://www.youtube.com/watch?v=ZCLyJfbzbrU Here is a video] of a user running Manjaro and some apps on their PineNote on 9/10/2022.

= Overview =

== Kernel modules / mainlining status ==

WORK IN PROGRESS !

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
|
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip_ebc</code>
|
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
| <code>tps65185</code>
|
|-
| LED backlight driver
| colspan="2" style="text-align:center;"|tbd
| <code>lm3630a</code>
|
|-
| Accelerometer
| colspan="2" style="text-align:center;"|tbd
| <code>st-accel-i2c</code>
|
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
|
|-
| Mali GPU
| 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]
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

= More Information =
== High-level developer new to embedded linux? ==
Here are some resources I have found helpful in learning to develop on embedded linux devices:
* Great youtube series introducing you to the kernel and lower-level components of Linux: https://www.youtube.com/watch?v=WiZ05pnHZqM
* https://embetronicx.com/
* https://bootlin.com/training/
* https://www.nand2tetris.org

== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip_ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==
Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files: 
- replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
- preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Building the most recent kernel ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel here].

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

== Emulator for Developing/Testing Pinenote Apps ==
https://github.com/michaelshiel/picom-epaper

= Flashing Software =
Currently, the only ways to flash software are from the factory Android installation (UART shell, adb, or fastboot) or by using rkdeveloptool.

== Backup of the content of the internal MMC before you mess anything up ==
Especially the '''waveform''' partition contains data '''unique''' to your PineNote and is a prime candidate for backup.

But other partitions like uboot (need for any operation of the device) or the un-partitioned space at the beginning containing the GPT partition table (and presumably the VCOM setting for the e-ink display and maybe device mac addresses) contains data you may wish to backup.

Depending of your personal level of data hoarder you may want to backup more than this or even just everything (the large userdata partition is supposed to be able to be repopulated as empty space by Android)

In any case it is easier to restore/extract data from a backup than not having one if you need one.

=== Manually using rkdeveloptool ===
Dorian has some nice [https://github.com/DorianRudolph/pinenotes notes regarding the PineNote]

Don't forget to install a patched uboot for reading beyond 32MB and to respect the 2GB limit/bug of the current rkdeveloptool as per his notes

=== Automated backup using a script and rkdeveloptool ===
[https://github.com/talpadk/pinenote-backup pinenote-backup] is a python script for detecting the partitions and automating the backup of partitions or the whole disk

I also requires a patched u-boot but automatically handles the 2GB limit by splitting up larger reads into smaller ones

=== Using the factory Android installation ===
For any one knowing how and with which caveats: Write ME

=== Using a user installed Linux ===
A Linux installed to the cache partition should be able to easily backup everything over WiFi or to a USB stick/disk using dd

However the user would need to backup the cache partition themself (if they want that).

And more importantly they would only be getting the backup ''after'' they started playing with the content of the MMC.

== Side-by-side setup ==

It is possible to set up a partition for mainline development without disturbing the factory Android installation. This allows updating a mainline kernel, DTB, and initramfs over Wi-Fi until WiFi or USB OTG is working in mainline Linux.

=== Without Repartitioning ===

The recommended partition for this is <tt>mmcblk0p11</tt> aka <tt>/cache</tt>. It is large and already formatted as <tt>ext4</tt>, so it is readable from U-Boot. Here are some general steps:

# From the UART or adb shell, set up your chroot in <tt>/cache</tt>. I used the Alpine Linux rootfs tarball.
# Copy in your kernel and DTB, using for example <tt>scp</tt> or <tt>wget</tt> inside the chroot.
# Finally, create and boot an <code>extlinux.conf</code> as described below.

=== With Repartitioning ===

It is possible to shrink the <tt>userdata</tt> partition, and create a new partition at the end for use with mainline Linux. This provides much more space than <tt>cache</tt>. However, because <tt>userdata</tt> is formatted with <tt>f2fs</tt>, and that filesystem cannot be shrunk, resizing the partition requires wiping <tt>userdata</tt>.

# Back up any necessary files from userdata
# Boot to a mainline kernel from <tt>mmcblk0p11</tt>, either using that partition as rootfs (see above), or using an initramfs with repartitioning tools
# Modify the partition table with your favorite tool, e.g. <tt>fdisk</tt>, <tt>gdisk</tt>, or <tt>parted</tt>
# Reboot into <tt>fastboot</tt> and wipe <tt>userdata</tt>.
# Reboot into Android, where you can now chroot in and install your favorite distribution to the new partition.

== Using rkdeveloptool ==

rkdeveloptool is a command line utility built on libusb.

=== Downloading and Building rkdeveloptool ===

PINE64 develops [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool its own updated fork of rkdeveloptool on GitLab].

You will need to have libusb 1.0, its development headers and scdoc installed.

<pre>
git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git
cd rkdeveloptool
mkdir build
cd build
cmake ..
</pre>

This sets up all the build files. You can then compile with <code>make</code> inside the build directory.

After you're done, you'll likely also need to install the udev rules, or else your user won't have permission to access the USB devices:

<pre>
sudo cp 99-rk-rockusb.rules /etc/udev/rules.d/
sudo udevadm control --reload
</pre>

Copying the udev rules is also performed automatically when you <code>make install</code>.

=== Building Downstream U-Boot ===

While in maskrom mode, we need to have a u-boot to download onto the device for any of the other commands to work. To build you'll also need to install device-tree-compiler.

You also need to install Python and pyelftools.

 Note that rkbin is a >5GB download! This will take some time to clone and process the deltas.

<pre>
git clone -b quartz64 https://gitlab.com/pgwipeout/u-boot-rockchip.git
git clone -b rkbin https://github.com/JeffyCN/rockchip_mirrors.git rkbin
cd u-boot-rockchip
# If using Arch Linux, export CROSS_COMPILE=aarch64-linux-gnu-
export CROSS_COMPILE=aarch64-none-linux-gnu-
make rk3566-quartz64_defconfig
./make.sh
</pre>

<blockquote>
In the version I cloned (current as of 2022-01-02), I had to make a change to one line to get a clean compilation:

<pre>
diff --git a/lib/avb/libavb/avb_slot_verify.c b/lib/avb/libavb/avb_slot_verify.c
index 123701fc3b..64a1ce6450 100644
--- a/lib/avb/libavb/avb_slot_verify.c
+++ b/lib/avb/libavb/avb_slot_verify.c
@@ -296,7 +296,7 @@ static AvbSlotVerifyResult load_and_verify_hash_partition(
bool image_preloaded = false;
uint8_t* digest;
size_t digest_len;
- const char* found;
+ const char* found = NULL;
uint64_t image_size;
size_t expected_digest_len = 0;
uint8_t expected_digest_buf[AVB_SHA512_DIGEST_SIZE];
</pre>

For systems where the global python executable points to python2, compilation fails with an error related to pyelftools not being installed (even if it is). To fix this:
<pre>
diff --git a/make.sh b/make.sh
index 2bba05b4e4..cfe5b0afd5 100755
--- a/make.sh
+++ b/make.sh
@@ -758,7 +758,7 @@ function pack_fit_image()
fi

if [ "${ARM64_TRUSTZONE}" == "y" ]; then
- if ! python -c "import elftools" ; then
+ if ! python3 -c "import elftools" ; then
echo "ERROR: No python 'pyelftools', please: pip install pyelftools"
exit 1
fi
</pre>
</blockquote>

=== Entering Maskrom/Rockusb Mode ===

There are three ways to get into Maskrom/Rockusb mode:

==== The easy way ====

# Flip the device around so that the display faces down
# Lay the pen on the right side, with its tip pointing towards the speaker grill, and its magnet pointing towards the upper right corner of the label on the back (or place the magnetic cap from the pen on the spot marked on the back).
# Turn the device on and wait for it to show up in <code>lsusb</code>. It should now be in Loader mode, according to <code>rkdeveloptool list-devices</code> (note that "Loader" here indicates U-Boot's Rockusb; separately, booting with an erased eMMC displays "Maskrom" [not "Loader"] from the RK3566).
# Unplug the device and plug it back in. It should now be in Rockusb mode.

This can be a bit fiddly to get right, and may need a few tries.

==== The u-boot way ====
# Interrupt the u-boot startup using ctrl-c (while attached using an UART dongle)
# While in u-boot use the command "rockusb 0 mmc 0" to start rockusb mode.

One benefit from this is, that if you have an UART dongle that allows to simultaneous having an UART and USB connection, there is no need to plug and unplug cables and flipping the PineNote around and placing magnets.

This is especially helpful when changing back and forth between u-boot and rockusb, for instance when trying to develop u-boot.

==== Shorting test points ====

If the bootloader is broken/corrupted, you cannot get to Maskrom without opening up the device (it can be opened using spudger and a bit of patience).

Once inside, short TP1301 (GND) and TP1302 (eMMC_D0/FLASH_D0) with a small tweezers, this is how it looks on board view (credit to Caleb):

[[File:PineNote_Maskrom_TP.png|500px]]

Then plug the device to the computer and if you see the device with VID=2207/PID=350a then it should be in Maskrom mode, you can verify by typing <code>rkdeveloptool list-devices</code>.

<nowiki>Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device found, idVendor=2207, idProduct=350a, bcdDevice= 1.00
Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device strings: Mfr=0, Product=0, SerialNumber=0

$ rkdeveloptool list-devices
DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom</nowiki>

If nothing shows up, you can try to hold down the power button for 5 seconds and then try again.

=== Running rkdeveloptool ===

First, you'll want to make sure the device you've connected is in maskrom mode:

<pre>
./rkdeveloptool list
</pre>

It should output something like <code>DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=202 Maskrom</code>. If it doesn't, see [[PineNote Development#Entering Maskrom Mode]].

You can now download u-boot onto it:
<pre>
./rkdeveloptool boot ../u-boot-rockchip/rk356x_spl_loader_v1.08.111.bin
</pre>

This should output <code>Downloading bootloader succeeded.</code>.

We can now verify that this worked using e.g. the "read flash info" command:

<pre>
./rkdeveloptool read-flash-info
</pre>

'''TODO:''' finish this section

=== Creating a mainline boot image ===

You can create a filesystem image that replaces the Android boot or recovery partition by doing roughly the following:

# Erase boot and dtbo with rkdeveloptool or fastboot (back them up first!!!)
# Create an ext2 partition image and mount it (fallocate, mkfs.ext2)
# Build your mainline kernel
# Copy the kernel, dtb and an initramfs to the root of the mounted image (use any old postmarketOS initramfs)
# Create a file in the root of the mounted image called <code>extlinux.conf</code> as described below
# Unmount the image and then use rkdeveloptool to flash it to the "recovery" partition on the pinenote (it's about the right size until we get around to replacing the partition layout).

== Using fastboot ==

Follow the steps for "Creating a mainline boot.img", but instead of flashing it with rkdeveloptool, use fastboot. You can enter fastboot in either of two ways:

# Use "reboot bootloader" from adb or a UART console.
# Get a U-Boot prompt and run <code>fastboot usb 0</code>.

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

PineNote Development

2023-01-10T15:41:04Z

Diederik: Make formatting in line with Quartz development table

This article seeks to provide general development information for the [[PineNote]]. If you are new and down to try a new installation process, the easiest way to get linux is likely to [https://wiki.pine64.org/wiki/PineNote_Development/Installing_Debian install Debian] -- NOTE THAT THIS INSTALLATION PROCESS IS VERY NEW. While many people have been using the kernel that will be installed safely at this point, the instructions for installing Debian via rootfs are very new. Take backups!

The more stable recommended approach is described below:

Start with [https://github.com/DorianRudolph/pinenotes Dorian's guide] which will guide you through getting Arch installed. For instructions on building the latest kernel, see [[PineNote Development/Building Kernel]]. For helpful configurations, see [[PineNote Development/Apps]]. For ways to pitch in, see [[PineNote Development/TODOs]]. To boot Linux by default instead of Android, see [[PineNote Development/Booting Linux]]. [https://www.youtube.com/watch?v=ZCLyJfbzbrU Here is a video] of a user running Manjaro and some apps on their PineNote on 9/10/2022.

= Overview =

== Kernel modules / mainlining status ==

WORK IN PROGRESS !

The following table aims to provide a list of kernel modules required for running the PineNote.
It also aims at listing repositories of work in progress.
While some overlap with the Quartz64 module list ([[Quartz64_Development#Upstreaming_Status]])
is expected, only modules relevant to the PineNote hardware should be listed here.

{|class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
| Touchscreen
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>cyttsp5</code>
| As of 6.2-rc1[https://git.kernel.org/linus/5b0c03e24a061f9c9e8b28fa157b80990c559a37]
|-
| Digitizer
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>i2c_hid_of</code>
|
|-
| Pen BLE Buttons
| colspan="2" style="text-align:center;"|tbd
| <code>ws8100-pen</code>
|
|-
| EBC Display controller
| colspan="2" style="text-align:center;"|tbd
| <code>rockchip_ebc</code>
|
|-
| EBC PMic
| colspan="2" style="text-align:center;"|tbd
|<code>tps65185</code>
|
|-
| LED backlight driver
| colspan="2" style="text-align:center;"|tbd
| lm3630a
|
|-
| Accelerometer
| colspan="2" style="text-align:center;"|tbd
| <code>st-accel-i2c</code>
|
|-
| Rastergraphics unit RGA2e
| colspan="2" style="text-align:center;"|tbd
| <code>rga</code> (v4l2 mem2mem driver)
|
|-
| Mali GPU
| 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]
|-
| Wifi/BT
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>brcmfmac</code>
|
|}

= More Information =
== High-level developer new to embedded linux? ==
Here are some resources I have found helpful in learning to develop on embedded linux devices:
* Great youtube series introducing you to the kernel and lower-level components of Linux: https://www.youtube.com/watch?v=WiZ05pnHZqM
* https://embetronicx.com/
* https://bootlin.com/training/
* https://www.nand2tetris.org

== Notes Written by Some Developers ==

* https://github.com/m-weigand/mw_pinenote_misc (Not super legible "notes", but very helpful repo with patches, videos, etc)
** specifically see this section for helpful install/configure scripts: https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches#compiling.
* https://github.com/0cc4m/pinenote-misc
** patch for enabling gpu: https://github.com/0cc4m/pinenote-misc/blob/main/mesa-archlinux-arm/mesa/rockchip_ebc.patch
** prebuilt pkg's: https://github.com/0cc4m/pinenote-misc/releases
* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Alternative to patching of mesa ==
Mesa needs to be patched to add the driver entry point. The alternative to this, is the renaming of the ebc driver to an existing mesa driver entry point. A good existing name can be "repaper". To change the driver name, edit in the kernel tree the following files: 
- replace "rockchip-ebc" with "repaper" in the two places in the file: drivers/gpu/drm/rockchip/rockchip_ebc.c 
- preventive, replace "repaper" with "repaper-disabled" in the two places in the file: drivers/gpu/drm/tiny/repaper.c 

== Building the most recent kernel ==
See [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel here].

== Video of Factory Android OS ==

[https://www.youtube.com/watch?v=DWuTGgQHw98 PineNote Developer Edition w/Tech Demo Android OS (Video Only)]

Informal walkthrough of the factory Android installation on the PineNote Developer Edition, recorded by a community member (Apr 2022). This is useful to look back at the original OS after erasing it from your device, or to get some additional detail before your device arrives.

The video also includes a chapter at the end showing [https://www.youtube.com/watch?v=DWuTGgQHw98&t=802s how to enable Android Debug Bridge (`adb`) over USB]. Once enabled, keep the device powered and connect a USB cable directly to the PineNote (i.e. no UART breakout) to a computer running `adb`.

== Emulator for Developing/Testing Pinenote Apps ==
https://github.com/michaelshiel/picom-epaper

= Flashing Software =
Currently, the only ways to flash software are from the factory Android installation (UART shell, adb, or fastboot) or by using rkdeveloptool.

== Backup of the content of the internal MMC before you mess anything up ==
Especially the '''waveform''' partition contains data '''unique''' to your PineNote and is a prime candidate for backup.

But other partitions like uboot (need for any operation of the device) or the un-partitioned space at the beginning containing the GPT partition table (and presumably the VCOM setting for the e-ink display and maybe device mac addresses) contains data you may wish to backup.

Depending of your personal level of data hoarder you may want to backup more than this or even just everything (the large userdata partition is supposed to be able to be repopulated as empty space by Android)

In any case it is easier to restore/extract data from a backup than not having one if you need one.

=== Manually using rkdeveloptool ===
Dorian has some nice [https://github.com/DorianRudolph/pinenotes notes regarding the PineNote]

Don't forget to install a patched uboot for reading beyond 32MB and to respect the 2GB limit/bug of the current rkdeveloptool as per his notes

=== Automated backup using a script and rkdeveloptool ===
[https://github.com/talpadk/pinenote-backup pinenote-backup] is a python script for detecting the partitions and automating the backup of partitions or the whole disk

I also requires a patched u-boot but automatically handles the 2GB limit by splitting up larger reads into smaller ones

=== Using the factory Android installation ===
For any one knowing how and with which caveats: Write ME

=== Using a user installed Linux ===
A Linux installed to the cache partition should be able to easily backup everything over WiFi or to a USB stick/disk using dd

However the user would need to backup the cache partition themself (if they want that).

And more importantly they would only be getting the backup ''after'' they started playing with the content of the MMC.

== Side-by-side setup ==

It is possible to set up a partition for mainline development without disturbing the factory Android installation. This allows updating a mainline kernel, DTB, and initramfs over Wi-Fi until WiFi or USB OTG is working in mainline Linux.

=== Without Repartitioning ===

The recommended partition for this is <tt>mmcblk0p11</tt> aka <tt>/cache</tt>. It is large and already formatted as <tt>ext4</tt>, so it is readable from U-Boot. Here are some general steps:

# From the UART or adb shell, set up your chroot in <tt>/cache</tt>. I used the Alpine Linux rootfs tarball.
# Copy in your kernel and DTB, using for example <tt>scp</tt> or <tt>wget</tt> inside the chroot.
# Finally, create and boot an <code>extlinux.conf</code> as described below.

=== With Repartitioning ===

It is possible to shrink the <tt>userdata</tt> partition, and create a new partition at the end for use with mainline Linux. This provides much more space than <tt>cache</tt>. However, because <tt>userdata</tt> is formatted with <tt>f2fs</tt>, and that filesystem cannot be shrunk, resizing the partition requires wiping <tt>userdata</tt>.

# Back up any necessary files from userdata
# Boot to a mainline kernel from <tt>mmcblk0p11</tt>, either using that partition as rootfs (see above), or using an initramfs with repartitioning tools
# Modify the partition table with your favorite tool, e.g. <tt>fdisk</tt>, <tt>gdisk</tt>, or <tt>parted</tt>
# Reboot into <tt>fastboot</tt> and wipe <tt>userdata</tt>.
# Reboot into Android, where you can now chroot in and install your favorite distribution to the new partition.

== Using rkdeveloptool ==

rkdeveloptool is a command line utility built on libusb.

=== Downloading and Building rkdeveloptool ===

PINE64 develops [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool its own updated fork of rkdeveloptool on GitLab].

You will need to have libusb 1.0, its development headers and scdoc installed.

<pre>
git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git
cd rkdeveloptool
mkdir build
cd build
cmake ..
</pre>

This sets up all the build files. You can then compile with <code>make</code> inside the build directory.

After you're done, you'll likely also need to install the udev rules, or else your user won't have permission to access the USB devices:

<pre>
sudo cp 99-rk-rockusb.rules /etc/udev/rules.d/
sudo udevadm control --reload
</pre>

Copying the udev rules is also performed automatically when you <code>make install</code>.

=== Building Downstream U-Boot ===

While in maskrom mode, we need to have a u-boot to download onto the device for any of the other commands to work. To build you'll also need to install device-tree-compiler.

You also need to install Python and pyelftools.

 Note that rkbin is a >5GB download! This will take some time to clone and process the deltas.

<pre>
git clone -b quartz64 https://gitlab.com/pgwipeout/u-boot-rockchip.git
git clone -b rkbin https://github.com/JeffyCN/rockchip_mirrors.git rkbin
cd u-boot-rockchip
# If using Arch Linux, export CROSS_COMPILE=aarch64-linux-gnu-
export CROSS_COMPILE=aarch64-none-linux-gnu-
make rk3566-quartz64_defconfig
./make.sh
</pre>

<blockquote>
In the version I cloned (current as of 2022-01-02), I had to make a change to one line to get a clean compilation:

<pre>
diff --git a/lib/avb/libavb/avb_slot_verify.c b/lib/avb/libavb/avb_slot_verify.c
index 123701fc3b..64a1ce6450 100644
--- a/lib/avb/libavb/avb_slot_verify.c
+++ b/lib/avb/libavb/avb_slot_verify.c
@@ -296,7 +296,7 @@ static AvbSlotVerifyResult load_and_verify_hash_partition(
bool image_preloaded = false;
uint8_t* digest;
size_t digest_len;
- const char* found;
+ const char* found = NULL;
uint64_t image_size;
size_t expected_digest_len = 0;
uint8_t expected_digest_buf[AVB_SHA512_DIGEST_SIZE];
</pre>

For systems where the global python executable points to python2, compilation fails with an error related to pyelftools not being installed (even if it is). To fix this:
<pre>
diff --git a/make.sh b/make.sh
index 2bba05b4e4..cfe5b0afd5 100755
--- a/make.sh
+++ b/make.sh
@@ -758,7 +758,7 @@ function pack_fit_image()
fi

if [ "${ARM64_TRUSTZONE}" == "y" ]; then
- if ! python -c "import elftools" ; then
+ if ! python3 -c "import elftools" ; then
echo "ERROR: No python 'pyelftools', please: pip install pyelftools"
exit 1
fi
</pre>
</blockquote>

=== Entering Maskrom/Rockusb Mode ===

There are three ways to get into Maskrom/Rockusb mode:

==== The easy way ====

# Flip the device around so that the display faces down
# Lay the pen on the right side, with its tip pointing towards the speaker grill, and its magnet pointing towards the upper right corner of the label on the back (or place the magnetic cap from the pen on the spot marked on the back).
# Turn the device on and wait for it to show up in <code>lsusb</code>. It should now be in Loader mode, according to <code>rkdeveloptool list-devices</code> (note that "Loader" here indicates U-Boot's Rockusb; separately, booting with an erased eMMC displays "Maskrom" [not "Loader"] from the RK3566).
# Unplug the device and plug it back in. It should now be in Rockusb mode.

This can be a bit fiddly to get right, and may need a few tries.

==== The u-boot way ====
# Interrupt the u-boot startup using ctrl-c (while attached using an UART dongle)
# While in u-boot use the command "rockusb 0 mmc 0" to start rockusb mode.

One benefit from this is, that if you have an UART dongle that allows to simultaneous having an UART and USB connection, there is no need to plug and unplug cables and flipping the PineNote around and placing magnets.

This is especially helpful when changing back and forth between u-boot and rockusb, for instance when trying to develop u-boot.

==== Shorting test points ====

If the bootloader is broken/corrupted, you cannot get to Maskrom without opening up the device (it can be opened using spudger and a bit of patience).

Once inside, short TP1301 (GND) and TP1302 (eMMC_D0/FLASH_D0) with a small tweezers, this is how it looks on board view (credit to Caleb):

[[File:PineNote_Maskrom_TP.png|500px]]

Then plug the device to the computer and if you see the device with VID=2207/PID=350a then it should be in Maskrom mode, you can verify by typing <code>rkdeveloptool list-devices</code>.

<nowiki>Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device found, idVendor=2207, idProduct=350a, bcdDevice= 1.00
Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device strings: Mfr=0, Product=0, SerialNumber=0

$ rkdeveloptool list-devices
DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom</nowiki>

If nothing shows up, you can try to hold down the power button for 5 seconds and then try again.

=== Running rkdeveloptool ===

First, you'll want to make sure the device you've connected is in maskrom mode:

<pre>
./rkdeveloptool list
</pre>

It should output something like <code>DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=202 Maskrom</code>. If it doesn't, see [[PineNote Development#Entering Maskrom Mode]].

You can now download u-boot onto it:
<pre>
./rkdeveloptool boot ../u-boot-rockchip/rk356x_spl_loader_v1.08.111.bin
</pre>

This should output <code>Downloading bootloader succeeded.</code>.

We can now verify that this worked using e.g. the "read flash info" command:

<pre>
./rkdeveloptool read-flash-info
</pre>

'''TODO:''' finish this section

=== Creating a mainline boot image ===

You can create a filesystem image that replaces the Android boot or recovery partition by doing roughly the following:

# Erase boot and dtbo with rkdeveloptool or fastboot (back them up first!!!)
# Create an ext2 partition image and mount it (fallocate, mkfs.ext2)
# Build your mainline kernel
# Copy the kernel, dtb and an initramfs to the root of the mounted image (use any old postmarketOS initramfs)
# Create a file in the root of the mounted image called <code>extlinux.conf</code> as described below
# Unmount the image and then use rkdeveloptool to flash it to the "recovery" partition on the pinenote (it's about the right size until we get around to replacing the partition layout).

== Using fastboot ==

Follow the steps for "Creating a mainline boot.img", but instead of flashing it with rkdeveloptool, use fastboot. You can enter fastboot in either of two ways:

# Use "reboot bootloader" from adb or a UART console.
# Get a U-Boot prompt and run <code>fastboot usb 0</code>.

= Mainline development =

== Status ==

Some work happening here: https://gitlab.com/calebccff/linux, the idea is to import the parts of the eink/ebc drivers which are open source and use the downstream u-boot framebuffer driver as a reference to create a basic framebuffer driver.

Currently mainline struggles to boot due to weird issues while probing fixed regulators (?). It also fails to detect eMMC.

Further work is being done here: https://github.com/smaeul/linux/commits/rk356x-ebc-dev. This has a complete device tree, with working eMMC. Pen input also works out of the box. Wi-Fi and BT work with firmware copied from the factory Android image.

== How to boot mainline ==

UART is currently REQUIRED for this to work! We depend on u-boot falling back to console. Once we have a prebuilt u-boot which will use extlinux by default, UART won't be needed anymore.

You can compile a u-boot that uses extlinux by default by following the instructions [https://github.com/JoshuaMulliken/pinenote_uboot/blob/aa9ecbd3d3e716f163f5a900824630f24e9f04ba/README.md#changing-default-boot-order here].

=== Getting to a U-Boot prompt ===

You can get to a U-Boot prompt by:

# Holding Ctrl-C while the display panel initializes.
# Wiping the "boot" partition.

=== Using sysboot ===

<code>extlinux.conf</code> should have the following contents:

<pre>
timeout 10
default MAINLINE
menu title boot prev kernel

label MAINLINE
kernel /vmlinuz
fdt /rk3566-pinenote.dtb
initrd /initramfs
append earlycon console=tty0 console=ttyS2,1500000n8 fw_devlink=off PMOS_NO_OUTPUT_REDIRECT
</pre>

At the u-boot console, run the following command to boot your mainline kernel:

<pre>
sysboot ${devtype} ${devnum}:9 any ${scriptaddr} extlinux.conf
</pre>

=== Booting with individual commands ===

Booting with individual commands can be useful when you need to temporarily add some kernel command line arguments. Use these or similar commands at the U-Boot shell:

load mmc 0:b ${kernel_addr_r} boot/Image
load mmc 0:b ${fdt_addr_r} boot/rk3566-pinenote.dtb
setenv bootargs ignore_loglevel root=/dev/mmcblk0p11 rootwait init=/bin/bash
booti ${kernel_addr_r} - ${fdt_addr_r}

== Configuration ==

=== Firmware for WiFi & Bluetooth and Waveform data ===

==== Using Maximilian's Debian image ====
If the Android partition (super) and waveform partition (waveform) is left intact the image extracts the WiFi, BT driver and waveform from the partitions on first run.

For instance if you repartitions the userdata partition and installs the image there.

==== Getting it from the Android install manually ====
Copy WiFi/BT firmware from Android:
mkdir -p /cache/lib/firmware/brcm
cp /vendor/etc/firmware/fw_bcm43455c0_ag_cy.bin /cache/lib/firmware/brcm/brcmfmac43455-sdio.bin
cp /vendor/etc/firmware/nvram_ap6255_cy.txt /cache/lib/firmware/brcm/brcmfmac43455-sdio.txt
cp /cache/lib/firmware/BCM4345C0.hcd /cache/lib/firmware/brcm/BCM4345C0.hcd

Copy waveform partition (via previously dumped file):
adb root
adb push waveform.img /cache/lib/firmware/waveform.bin

Or via dd within Linux:
dd if=/dev/mmcblk0p3 of=/lib/firmware/waveform.bin bs=1k count=2048

==== Getting the Wifi and Bluetooth driver blobs from "other" sources ====
===== WiFi =====
The WiFi firmware .bin blob can be obtained by installing the Debian package firmware-brcm80211 (in the non-free section)

The WiFi brcmfmac43455-sdio.txt file can according to Eugen be sourced from https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/brcm/brcmfmac43455-sdio.AW-CM256SM.txt needs a renaming when copying it to /lib/firmware/brcm/brcmfmac43455-sdio.txt)

''The content of the upstream .txt is different than the Android configuration, but is supposed to work.''

As you don't have WiFi yet you need to get the firmware-brcm80211*.deb and brcmfmac43455-sdio.txt file on the PineNote by other means, for instance using an USB stick

===== Bluetooth =====

Once you have WiFi working you can get BCM4345C0.hcd by installing the bluez-firmware
sudo apt install bluez-firmware

=== Configuring the E-ink refresh mode ===
https://github.com/m-weigand/mw_pinenote_misc/tree/main/rockchip_ebc/patches contains information on how/where to write in /sys to alter the refresh mode

https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension contains the gnome extension used in Maximilian image

=== Touchscreen and Pen In X.org ===

By default the pen config is flipped 180° (which makes it unusable) and the touchscreen doesn't work. Placing the following config in <code>/etc/X11/xorg.conf.d/50-touchscreen.conf</code> will fix both problems:

<pre>
Section "InputClass"
Identifier "evdev touchscreen"
MatchProduct "tt21000"
MatchIsTouchscreen "on"
Driver "evdev"
EndSection
Section "InputClass"
Identifier "RotateTouch"
MatchProduct "w9013"
Option "TransformationMatrix" "-1 0 1 0 -1 1 0 0 1"
EndSection
</pre>

Quartz64

2022-11-18T09:53:38Z

Diederik: Ethernet works OOTB on Model-A with Debian's kernel using 'm'

[[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|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, as some images' u-boot may have no video output on this chip.}}
{{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.

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 using [https://github.com/Plebian-Linux/quartz64-images CounterPillows quartz64-images]. Both with the kernel included (compiled during image creation with [https://github.com/Plebian-Linux/quartz64-images/commit/2ecbd46778d2d7e8fbb22fd86d39a781ce9aebc1#diff-b79606fb3afea5bd1609ed40b622142f1c98125abcfe89a76a661b0e8e343910 Debian's kernel config]) as with a kernel I compiled myself using tooling the Debian kernel team uses too.

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

ROCK64 Software Releases

2022-05-22T22:20:54Z

Diederik: capitalize the 'l' in LibreELEC

This page contains a list of all available releases for the [[ROCK64]], as well as links to other resources.

= Linux Image Releases =

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

* Version 5.88 onward support Rock64-v3 board
* To find out more about Armbian and available options please visit their [https://www.armbian.com/rock64/ site]
* Armbian pack as 7zip, please unzip first before dd.
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]

=== Armbian Ubuntu Focal XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal XFCE Desktop download site]

=== Armbian Ubuntu Bionic XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Bionic XFCE DEsktop download site]
* Login with
** username: root
** password: 1234

=== Armbian Debian Buster for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Debian Buster
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Debian Buster download site]

=== Armbian Ubuntu Focal for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Ubuntu Focal
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal download site]

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

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

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

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

=== AOSC Cinnamon Community Build Image [microSD and eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/rockchip64/cinnamon/rock64/ Direct download from AOSC]

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

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

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

Manjaro editions for Rock64 are available directly from Manjaro.

[https://manjaro.org/download/#rock64 Manjaro Rock64 Download Page]

* '''Only support ROCK64 ver2 SBC'''
* To learn more about Manjaro please visit [https://forum.manjaro.org/tags/manjaroarm Manjaro Forum]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]

== Ubuntu 18.04 Bionic by ayufan ==
[[File:penguin.png|right|100px]]

* [https://github.com/ayufan-rock64/linux-build/releases ayufan ROCK64 Linux Build GitHub]
* Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* Login with
** username: rock64
** password: rock64

=== Ubuntu 18.04 Bionic LXDE Desktop (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-lxde-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 64bit (arm64) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 32bit (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic containers (DockerCE & Kubernetes) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-containers-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

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

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

=== Slackware Aarch64 XFCE Community Build Image [microSD Boot] ===
* System with a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-xfce-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

=== Slackware Aarch64 Miniroot Community Build Image [microSD Boot] ===
* System without a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-base-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

* To run the OS on eMMC
**Flash the image to micro SD, power up the board with micro SD and login
**Copy the image file to micro SD by using SFTP. The image file must be in .img. ''note : root user are not allow transfer file to micro SD.''
**After finish copy the file, power off the board and add eMMC module to the board
**Bootup the board, run below command for flashing to eMMC module
***>>dd if=[image file] of=/dev/mmcblk1 bs=10M
****''example : dd if=slack-current-aarch64-xfce_08May18-4.4.126-rock64-build-20180508.img of=/dev/mmcblk1 bs=10M''
***then edit 2 files in eMMC module:
***>> mount /dev/mmcblk1p1 /media
***>> echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt
***>> sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab
**After done, power off board and remove micro SD. Then bootup with only eMMC module.

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

== LibreELEC (KODI) ==
[[File:libreelec.jpg|right|100px]]

=== Official LibreELEC KODI Build Image [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://libreelec.tv/downloads/rockchip/ Direct download from LibreElec site and look for PINE64 LibreELEC-RK3328.arm-x.x.x-rock64.img.gz]

=== Daily Build images (for testing) [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://test.libreelec.tv/ Direct download from LibreElec site and put 'rock64' in the search box]

== Volumio 2 Digital Audio Player ==
[[File:volumio.png|right|100px]]

* Volumio is a linux-based headless DAP (digital audio player), which connects to your home stereo system or your DAC
* Visit the project's website [https://community.volumio.org/t/volumio-2-on-rock64/8192 here]
* You can follow the ongoing discussion about Volumio on the [https://forum.pine64.org/showthread.php?tid=5322 PINE64 forum]

=== Volumio Digital Audio Player Community Build Image [microSD Boot] [2.528-2019-01-12] ===
* DD image (for 8GB microSD card and above)
** [https://updates.volumio.org/rock64/volumio/2.861/volumio-2.861-2020-12-22-rock64.img.zip Direct download from volumio.org]
* Login with
** Username: volumio
** Password: volumio
* '''Volumio is controlled using a Web-GUI which can be accessed via a web browser using the boards IP or volumio.local/'''

== Lakka ==
[[File:lakka.png|right|100px]]

=== Lakka Community Build Image [microSD / eMMC Boot] ===
* [https://www.lakka.tv/ Lakka] The open source game console; a lightweight Linux distribution that transforms the Rock64 into a full blown retrogaming console
* Visit [https://forum.pine64.org/showthread.php?tid=5354 PINE64 forum] for more information about the Lakka release
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://le.builds.lakka.tv/legacy-2.3/Rockchip.ROCK64.arm/ Direct download from Lakka]
* [[Lakka|Lakka Basic Setup]]

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

=== Debian Installer - Bullseye ===
* Go to Debian Bullseye's [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-bullseye-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and connect a serial console and boot up to start the Debian Installer

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

=== Debian Installer - Daily Build (for Bookworm+) ===
* Go to Debian's daily build [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-daily-build-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and boot up to start the Debian Installer. It should work with both a [https://bugs.debian.org/1009014 normal display and a serial console]

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

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

=== Debian Stretch Minimal 64bit (arm64) OS Image [microSD / eMMC Boot] [0.8.3] ===
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-minimal-rock64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 212MB
* Login with
** username: rock64
** password: rock64
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309&pid=39314#pid39314 here]

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

=== Minimal Debian [microSD / eMMC Boot] ===
** DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/mrfixit2001/debian_builds/releases Direct download from mrfixit2001's github]
** Version 190514 onward support Rock64-v3 board
* Login with
** username: rock
** password: rock

== OpenMediaVault ==
[[File:omv.png|right|100px]]

=== Jessie OpenMediaVault Community Build Image [microSD to eMMC] [0.5.15-136] by ayufan ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page]
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
'''* There's a bug with eMMC in the "Stable" version of openmediavault linked from the wiki page. In order to use eMMC, please you need to be on the latest (pre-release) version which is linked here https://github.com/ayufan-rock64/linux-build/releases'''
*
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github]
* [https://files.pine64.org/os/ROCK64/omv/jessie-openmediavault-rock64-0.5.15-136-armhf_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7E423EF9146EA15403E7D1B4EA30594A
** File Size: 487MB
** Credentials (console/ssh, except OMV): rock64/rock64
** Credentials (OMV for Web): admin/openmediavault
** Credentials (OMV for console): root/openmediavault
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

=== Stretch OpenMediaVault OS Image 32bit (armhf) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rock64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
** size: 391MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

=== Stretch OpenMediaVault OS Image 64bit (arm64) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 340MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

== NextCloudPi==
[[File:nextcloudpi.png|right|100px]]

=== NextCloudPi Community Build Image [microSD / eMMC Boot] [03-10-19] ===
* NextCloudPi comes not only with NextCloud preinstalled, but also with management tools for backups, SSL certificates, SAMBA, enhanced security and more.
* Visit the project's [https://nextcloudpi.com website]
* You can follow the ongoing discussion about NextCloudPi on the [https://forum.pine64.org/showthread.php?tid=6047 PINE64 forum]
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://files.pine64.org/os/ROCK64/nextcloudplus/NextCloudPi_Rock64_03-10-19.img.xz Direct download from pine64.org]
*** MD5 (XZ file): 1432c8b8082696f38770004b3cb5ac1e
*** File Size: 310MB
* Login with
** username: root
** password: 1234

== Recalbox ==
[[File:RB.png|right|100px]]

=== Recalbox Community Build Image [microSD / eMMC boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Recalbox allows you to re-play a variety of videogame consoles and platforms in your living room, with ease!
* To find out more about Recalbox and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7111 PINE64 forum thread]
*Visit the project's [https://www.recalbox.com/ website]
* DD image (for 8GB microSD card and above)
** [https://github.com/mrfixit2001/recalbox_rock64/releases Direct download latest release build from mrfixit2001 github]

== Cent OS [No Longer Maintained] ==
[[File:Centos.png|right|100px]]

=== CentOS-7 Community Build Image [microSD Boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Centos-7.4.1708 with kernel from Armbian-5.69 (minimum build)
** DD image (for 8GB microSD card and above)
** [https://github.com/Project31/centos-pine64/releases/download/v7.4.1708-v5.59/centos7-rock64.img.xz Project31 download mirrors]
* To find out more on installation process, please visit their [https://project31.github.io/pine64/ Project31 site]
* Login with
** username: root
** password: centos

== NEMS Linux ==
[[File:nems.jpg|right|100px]]

https://files.pine64.org/sw/pine64_installer/json/nems.jpg
* '''Only support ROCK64 ver2 SBC'''
* NEMS stands for "Nagios Enterprise Monitoring Server" and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers.
* To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread]
* Login with
** Username: nemsadmin
** Password: nemsadmin
* [https://docs.nemslinux.com/installation Installation Guide]
* To find out more on NEM Linux, please visit their [https://nemslinux.com/ site]

=== NEMS Linux [microSD / eMMC boot] [v1.5 - build 2] ===
* DD image (for 16GB microSD card and above)
** [https://nemslinux.com/download/nagios-for-pine64.php Download torrent seed from NEMS Linux]
** [https://files.pine64.org/os/ROCK64/nems/NEMS_v1.5-Rock64-Build2.zip Direct download from pine64.org]
*** MD5 (XZ file): 6e2088922c5d197db8b8ba3057120389
*** File Size: 1.30GB

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

=== Fedora Minimal Community Build Image [microSD boot] [Preliminary Build] ===
* [https://github.com/fire219/rock64-fedora/releases/ Follow up on Fire219 github]

= BSD Image Releases =

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

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

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

* You can install OpenBSD on your Rock64 by following [https://github.com/krjdev/rock64_openbsd these instructions]
 

==FreeBSD==
<div style=float:right>[[File:Freebsd_Logo.png|right|100px]]</div>
The [https://wiki.freebsd.org/arm/RockChip#Rock64 RockChip FreeBSD page] has instructions for installing FreeBSD.

* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]
* Version 13.0 and greater include prebuilt images. Find the link in the SD Card Images section and download the ROCK64 image.
* SSH is enable by default and can be accessed with the following account:
:: username: freebsd
:: password: freebsd
* The root account credentials are:
:: username: root
:: password: root

= Android Image Releases =

== Android TV 9.x eMMC (No Google Play) ==
[[File:android_9.png|right|100px]]

'''* For install Playstore on Android 9.0, please follows [https://forum.pine64.org/showthread.php?tid=8655 this forum thread]'''

=== Android 9.0 Stock Image [eMMC Boot] using DD method [20190617] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D985808B4CA912201372DC2F5F322AE9
*** File Size: 560MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5D65A44F78BD08B4584413C8BEEAAF05
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): B34D1C119386CBA1658E5F0FB9E4413D
*** File Size: 615MB

=== Android 9.0 Stock Image [eMMC Boot] using ROCKChip tools method [20190617] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Android TV build version
** [https://files.pine64.org/os/ROCK64/android/ROCK64_20190617_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 9B717263E7749A732C8B5C7D7D59C5C6
*** File Size: 544MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using DD method [20190618] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): DBB5B3D46B77A33BC9F09173C9788E6E
*** File Size: 561MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5F3B97EA72B3227082500B3FB1FAB44A
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 6833B124ABA3AC2269A6B4F51EFD1109
*** File Size: 615MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using ROCKChip tools method [20190618] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190618_stock_rooted_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): FC5F80C3A939AD0F8DCE5B85F22D20A1
** File Size: 544MB

== Android 9.x (No Google Play) ==
[[File:android_9.png|right|100px]]

=== Android 9.0 Stock Rooted Image [microSD Boot] using DD method [20190621] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* DD image for 8GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): A250B72CD6AAB24B8156DE08EB15530C
*** File Size: 546MB
* DD image for 16GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09A6BACD71159853D5E4C6C21C883B0F
*** File Size: 556MB
* DD image for 32GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): C68DC5D96F1C546B96EC690CE7BFE910
*** File Size: 574MB
* DD image for 64GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4EFC87B4CEE4C7655618DCA95EF7DD0D
*** File Size: 707MB

=== Android 9.0 Stock Rooted Image [microSD Boot] using ROCKChip SDDisk tools method [20190621] ===
* Please unzip first and then using Android tool to flash in
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://files.pine64.org/os/ROCK64/android/SDDiskTool_v1.57.zip Rockchip SDDisk Tool ver 1.57]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190621_stock_rooted_android_9.0_sdboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): EE00D309745F842213E21B2F1E20C510
** File Size: 539MB

== Android 8.x TV eMMC (preinstalled Google Play Store) ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [eMMC Boot] using DD method [20180606] ===
* DD image to eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180606_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): C05846B89A6483DA911CEA604627524F
** File Size: 561MB

=== Android 8.1. Stock Image [eMMC Boot] using ROCKChip tools method [20180606] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/rock64_android8.1_emmc_boot_v1.1.zip Direct download from pine64.org]
** MD5 (XZ file): 9738F060D2F62A83637797363D2B38C9
** File Size: 752MB

== Android 8.x TV ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [microSD Boot] [20180623] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180623_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 85372A568C114ADE7CD9632CEBA193E9
** File Size: 575MB

== Android 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android 7.1.2 Stock Image [microSD to eMMC] [Rooted] [20171204] ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper, then it will start writing the new image to the eMMC. Please allow around 1 minute of boot up time before UI is presented via HDMI
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 43443467DFCAEDE767556843EB4D6707
** File Size: 558MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android 7.1.2 Stock Image [eMMC Boot] [Rooted] [20171204] ===
* Please unzip first and then using Android tool to flash in
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7C831F9E6B4311A3B3D4743FBBB628D0
** File Size: 544MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

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

=== Android 7.1.2 Stock Image [microSD Boot] [Rooted] [20171204] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 56520ED3DB6E587DA140AD314A055EB2
** File Size: 544MB

== Android TV 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD to eMMC] [v0.3.4-r86] by ayufan ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
* [https://github.com/ayufan-rock64/android-7.1/releases/tag/0.3.4 Release notes on ayufan Android 7.1 github]
* Please allow 5 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/android-7.1-rock-64-rock64_atv-v0.3.4-r86-raw_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 6FD1FA4BE87EC2D4E0862F66541BC6F0
** File Size: 716MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android TV 7.1 Community Build Image [eMMC] by ayufan ===
* For eMMC flash-all image, please unzip first and then use Android tool to flash in
** [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-update.zip]
* See [[ROCK64 MAC Address]] on how to set the MAC address.

== Android TV 7.x ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD Boot] by ayufan ===
* [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-raw.img.gz]

= Android SDK =

=== Android P SDK [v9.0] ===
* [https://files.pine64.org//SDK/ROCK64/ROCK64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 1EAC08942E238293E3AF11C7890DF307
** File Size: 104.34GB

[[Category:Rock64]]

QuartzPro64 Development

2022-05-05T01:54:10Z

Diederik: Update 'Basic RK3588 Support' links on patchwork to v2 (from v1)

[[File:Quartzpro64_whole_board_top_resized.jpeg|250px|thumb|right|The QuartzPro64 development 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.

= Upstreaming Status =

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
! scope="row" | Video Output
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>VOP2</code>
| 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 (once it's merged)
|-
! scope="row" | Video Input
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
|
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://lore.kernel.org/all/20220211202728.6146-1-alyssa.rosenzweig@collabora.com/]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| Initial support in Mesa as of 22.2[https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/16035], changes specific to this SoC may be needed to both kernel and Mesa.
|-
! 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>
| 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>
| VDPU720 handling JPEG
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>?</code> using <code>v4l2-requests</code>
| 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. Very unfinished GStreamer implementation, doesn't allow for e.g. controlling the quality.
|-
| 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" | Audio
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-i2s-tdm</code>
| Should be exactly the same as RK356x (according to the TRM), just needs compatible string copypasted over probably
|-
! scope="row" | CRU
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=638462]
| <code>clk-rk3588</code>
|
|-
! scope="row" | SD/MMC
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=638462]
| <code>sdhci-of-dwcmshc</code>
|
|-
! scope="row" | pinctrl
| colspan="2" style="background:LightYellow; text-align:center;"|linux-next[https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?id=fdc33eba11c5919199f3d13dc53571cc7bf19d7d]
| <code>pinctrl-rockchip</code>
|
|-
! scope="row" | GPIO
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=638462]
| <code>rockchip-gpio</code>
|
|}

= Hardware =

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

== General ==

* RK3588 SoC
* 16 GB SK hynix DRAM

== Cooler ==

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

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

== UART ==

Plug in the USB-C port labelled "<tt>DEBUG PORT</tt>" on the board, it will show up as a FT232 USB Serial adapter. Baud rate is as usual 1.5mbauds or 1500000.

== Mounting Holes ==

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

== Storage ==

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

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

== PMU ==

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

RK806-2, probably RK808 compatible?

Verify this once we have access to SDK sources.

= Resources =

* [https://patchwork.kernel.org/project/linux-rockchip/list/ linux-rockchip patchwork]

[[Category:Rockchip RK3588]]

ROCK64 Software Releases

2022-05-02T21:16:44Z

Diederik: Convert URL into clickable link; change 'as' -> 'and'

This page contains a list of all available releases for the [[ROCK64]], as well as links to other resources.

= Linux Image Releases =

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

* Version 5.88 onward support Rock64-v3 board
* To find out more about Armbian and available options please visit their [https://www.armbian.com/rock64/ site]
* Armbian pack as 7zip, please unzip first before dd.
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]

=== Armbian Ubuntu Focal XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal XFCE Desktop download site]

=== Armbian Ubuntu Bionic XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Bionic XFCE DEsktop download site]
* Login with
** username: root
** password: 1234

=== Armbian Debian Buster for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Debian Buster
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Debian Buster download site]

=== Armbian Ubuntu Focal for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Ubuntu Focal
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal download site]

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

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

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

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

=== AOSC Cinnamon Community Build Image [microSD and eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/rockchip64/cinnamon/rock64/ Direct download from AOSC]

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

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

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

Manjaro editions for Rock64 are available directly from Manjaro.

[https://manjaro.org/download/#rock64 Manjaro Rock64 Download Page]

* '''Only support ROCK64 ver2 SBC'''
* To learn more about Manjaro please visit [https://forum.manjaro.org/tags/manjaroarm Manjaro Forum]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]

== Ubuntu 18.04 Bionic by ayufan ==
[[File:penguin.png|right|100px]]

* [https://github.com/ayufan-rock64/linux-build/releases ayufan ROCK64 Linux Build GitHub]
* Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* Login with
** username: rock64
** password: rock64

=== Ubuntu 18.04 Bionic LXDE Desktop (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-lxde-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 64bit (arm64) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 32bit (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic containers (DockerCE & Kubernetes) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-containers-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

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

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

=== Slackware Aarch64 XFCE Community Build Image [microSD Boot] ===
* System with a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-xfce-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

=== Slackware Aarch64 Miniroot Community Build Image [microSD Boot] ===
* System without a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-base-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

* To run the OS on eMMC
**Flash the image to micro SD, power up the board with micro SD and login
**Copy the image file to micro SD by using SFTP. The image file must be in .img. ''note : root user are not allow transfer file to micro SD.''
**After finish copy the file, power off the board and add eMMC module to the board
**Bootup the board, run below command for flashing to eMMC module
***>>dd if=[image file] of=/dev/mmcblk1 bs=10M
****''example : dd if=slack-current-aarch64-xfce_08May18-4.4.126-rock64-build-20180508.img of=/dev/mmcblk1 bs=10M''
***then edit 2 files in eMMC module:
***>> mount /dev/mmcblk1p1 /media
***>> echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt
***>> sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab
**After done, power off board and remove micro SD. Then bootup with only eMMC module.

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

== LibreELEC (KODI) ==
[[File:libreelec.jpg|right|100px]]

=== Official LibreElEC KODI Build Image [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://libreelec.tv/downloads/rockchip/ Direct download from LibreElec site and look for PINE64 LibreELEC-RK3328.arm-x.x.x-rock64.img.gz]

=== Daily Build images (for testing) [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://test.libreelec.tv/ Direct download from LibreElec site and put 'rock64' in the search box]

== Volumio 2 Digital Audio Player ==
[[File:volumio.png|right|100px]]

* Volumio is a linux-based headless DAP (digital audio player), which connects to your home stereo system or your DAC
* Visit the project's website [https://community.volumio.org/t/volumio-2-on-rock64/8192 here]
* You can follow the ongoing discussion about Volumio on the [https://forum.pine64.org/showthread.php?tid=5322 PINE64 forum]

=== Volumio Digital Audio Player Community Build Image [microSD Boot] [2.528-2019-01-12] ===
* DD image (for 8GB microSD card and above)
** [https://updates.volumio.org/rock64/volumio/2.861/volumio-2.861-2020-12-22-rock64.img.zip Direct download from volumio.org]
* Login with
** Username: volumio
** Password: volumio
* '''Volumio is controlled using a Web-GUI which can be accessed via a web browser using the boards IP or volumio.local/'''

== Lakka ==
[[File:lakka.png|right|100px]]

=== Lakka Community Build Image [microSD / eMMC Boot] ===
* [https://www.lakka.tv/ Lakka] The open source game console; a lightweight Linux distribution that transforms the Rock64 into a full blown retrogaming console
* Visit [https://forum.pine64.org/showthread.php?tid=5354 PINE64 forum] for more information about the Lakka release
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://le.builds.lakka.tv/legacy-2.3/Rockchip.ROCK64.arm/ Direct download from Lakka]
* [[Lakka|Lakka Basic Setup]]

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

=== Debian Installer - Bullseye ===
* Go to Debian Bullseye's [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-bullseye-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and connect a serial console and boot up to start the Debian Installer

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

=== Debian Installer - Daily Build (for Bookworm+) ===
* Go to Debian's daily build [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-daily-build-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and boot up to start the Debian Installer. It should work with both a [https://bugs.debian.org/1009014 normal display and a serial console]

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

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

=== Debian Stretch Minimal 64bit (arm64) OS Image [microSD / eMMC Boot] [0.8.3] ===
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-minimal-rock64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 212MB
* Login with
** username: rock64
** password: rock64
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309&pid=39314#pid39314 here]

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

=== Minimal Debian [microSD / eMMC Boot] ===
** DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/mrfixit2001/debian_builds/releases Direct download from mrfixit2001's github]
** Version 190514 onward support Rock64-v3 board
* Login with
** username: rock
** password: rock

== OpenMediaVault ==
[[File:omv.png|right|100px]]

=== Jessie OpenMediaVault Community Build Image [microSD to eMMC] [0.5.15-136] by ayufan ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page]
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
'''* There's a bug with eMMC in the "Stable" version of openmediavault linked from the wiki page. In order to use eMMC, please you need to be on the latest (pre-release) version which is linked here https://github.com/ayufan-rock64/linux-build/releases'''
*
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github]
* [https://files.pine64.org/os/ROCK64/omv/jessie-openmediavault-rock64-0.5.15-136-armhf_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7E423EF9146EA15403E7D1B4EA30594A
** File Size: 487MB
** Credentials (console/ssh, except OMV): rock64/rock64
** Credentials (OMV for Web): admin/openmediavault
** Credentials (OMV for console): root/openmediavault
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

=== Stretch OpenMediaVault OS Image 32bit (armhf) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rock64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
** size: 391MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

=== Stretch OpenMediaVault OS Image 64bit (arm64) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 340MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

== NextCloudPi==
[[File:nextcloudpi.png|right|100px]]

=== NextCloudPi Community Build Image [microSD / eMMC Boot] [03-10-19] ===
* NextCloudPi comes not only with NextCloud preinstalled, but also with management tools for backups, SSL certificates, SAMBA, enhanced security and more.
* Visit the project's [https://nextcloudpi.com website]
* You can follow the ongoing discussion about NextCloudPi on the [https://forum.pine64.org/showthread.php?tid=6047 PINE64 forum]
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://files.pine64.org/os/ROCK64/nextcloudplus/NextCloudPi_Rock64_03-10-19.img.xz Direct download from pine64.org]
*** MD5 (XZ file): 1432c8b8082696f38770004b3cb5ac1e
*** File Size: 310MB
* Login with
** username: root
** password: 1234

== Recalbox ==
[[File:RB.png|right|100px]]

=== Recalbox Community Build Image [microSD / eMMC boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Recalbox allows you to re-play a variety of videogame consoles and platforms in your living room, with ease!
* To find out more about Recalbox and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7111 PINE64 forum thread]
*Visit the project's [https://www.recalbox.com/ website]
* DD image (for 8GB microSD card and above)
** [https://github.com/mrfixit2001/recalbox_rock64/releases Direct download latest release build from mrfixit2001 github]

== Cent OS [No Longer Maintained] ==
[[File:Centos.png|right|100px]]

=== CentOS-7 Community Build Image [microSD Boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Centos-7.4.1708 with kernel from Armbian-5.69 (minimum build)
** DD image (for 8GB microSD card and above)
** [https://github.com/Project31/centos-pine64/releases/download/v7.4.1708-v5.59/centos7-rock64.img.xz Project31 download mirrors]
* To find out more on installation process, please visit their [https://project31.github.io/pine64/ Project31 site]
* Login with
** username: root
** password: centos

== NEMS Linux ==
[[File:nems.jpg|right|100px]]

https://files.pine64.org/sw/pine64_installer/json/nems.jpg
* '''Only support ROCK64 ver2 SBC'''
* NEMS stands for "Nagios Enterprise Monitoring Server" and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers.
* To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread]
* Login with
** Username: nemsadmin
** Password: nemsadmin
* [https://docs.nemslinux.com/installation Installation Guide]
* To find out more on NEM Linux, please visit their [https://nemslinux.com/ site]

=== NEMS Linux [microSD / eMMC boot] [v1.5 - build 2] ===
* DD image (for 16GB microSD card and above)
** [https://nemslinux.com/download/nagios-for-pine64.php Download torrent seed from NEMS Linux]
** [https://files.pine64.org/os/ROCK64/nems/NEMS_v1.5-Rock64-Build2.zip Direct download from pine64.org]
*** MD5 (XZ file): 6e2088922c5d197db8b8ba3057120389
*** File Size: 1.30GB

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

=== Fedora Minimal Community Build Image [microSD boot] [Preliminary Build] ===
* [https://github.com/fire219/rock64-fedora/releases/ Follow up on Fire219 github]

= BSD Image Releases =

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

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

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

* You can install OpenBSD on your Rock64 by following [https://github.com/krjdev/rock64_openbsd these instructions]
 

==FreeBSD==
<div style=float:right>[[File:Freebsd_Logo.png|right|100px]]</div>
The [https://wiki.freebsd.org/arm/RockChip#Rock64 RockChip FreeBSD page] has instructions for installing FreeBSD.

* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]
* Version 13.0 and greater include prebuilt images. Find the link in the SD Card Images section and download the ROCK64 image.
* SSH is enable by default and can be accessed with the following account:
:: username: freebsd
:: password: freebsd
* The root account credentials are:
:: username: root
:: password: root

= Android Image Releases =

== Android TV 9.x eMMC (No Google Play) ==
[[File:android_9.png|right|100px]]

'''* For install Playstore on Android 9.0, please follows [https://forum.pine64.org/showthread.php?tid=8655 this forum thread]'''

=== Android 9.0 Stock Image [eMMC Boot] using DD method [20190617] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D985808B4CA912201372DC2F5F322AE9
*** File Size: 560MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5D65A44F78BD08B4584413C8BEEAAF05
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): B34D1C119386CBA1658E5F0FB9E4413D
*** File Size: 615MB

=== Android 9.0 Stock Image [eMMC Boot] using ROCKChip tools method [20190617] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Android TV build version
** [https://files.pine64.org/os/ROCK64/android/ROCK64_20190617_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 9B717263E7749A732C8B5C7D7D59C5C6
*** File Size: 544MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using DD method [20190618] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): DBB5B3D46B77A33BC9F09173C9788E6E
*** File Size: 561MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5F3B97EA72B3227082500B3FB1FAB44A
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 6833B124ABA3AC2269A6B4F51EFD1109
*** File Size: 615MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using ROCKChip tools method [20190618] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190618_stock_rooted_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): FC5F80C3A939AD0F8DCE5B85F22D20A1
** File Size: 544MB

== Android 9.x (No Google Play) ==
[[File:android_9.png|right|100px]]

=== Android 9.0 Stock Rooted Image [microSD Boot] using DD method [20190621] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* DD image for 8GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): A250B72CD6AAB24B8156DE08EB15530C
*** File Size: 546MB
* DD image for 16GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09A6BACD71159853D5E4C6C21C883B0F
*** File Size: 556MB
* DD image for 32GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): C68DC5D96F1C546B96EC690CE7BFE910
*** File Size: 574MB
* DD image for 64GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4EFC87B4CEE4C7655618DCA95EF7DD0D
*** File Size: 707MB

=== Android 9.0 Stock Rooted Image [microSD Boot] using ROCKChip SDDisk tools method [20190621] ===
* Please unzip first and then using Android tool to flash in
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://files.pine64.org/os/ROCK64/android/SDDiskTool_v1.57.zip Rockchip SDDisk Tool ver 1.57]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190621_stock_rooted_android_9.0_sdboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): EE00D309745F842213E21B2F1E20C510
** File Size: 539MB

== Android 8.x TV eMMC (preinstalled Google Play Store) ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [eMMC Boot] using DD method [20180606] ===
* DD image to eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180606_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): C05846B89A6483DA911CEA604627524F
** File Size: 561MB

=== Android 8.1. Stock Image [eMMC Boot] using ROCKChip tools method [20180606] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/rock64_android8.1_emmc_boot_v1.1.zip Direct download from pine64.org]
** MD5 (XZ file): 9738F060D2F62A83637797363D2B38C9
** File Size: 752MB

== Android 8.x TV ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [microSD Boot] [20180623] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180623_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 85372A568C114ADE7CD9632CEBA193E9
** File Size: 575MB

== Android 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android 7.1.2 Stock Image [microSD to eMMC] [Rooted] [20171204] ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper, then it will start writing the new image to the eMMC. Please allow around 1 minute of boot up time before UI is presented via HDMI
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 43443467DFCAEDE767556843EB4D6707
** File Size: 558MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android 7.1.2 Stock Image [eMMC Boot] [Rooted] [20171204] ===
* Please unzip first and then using Android tool to flash in
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7C831F9E6B4311A3B3D4743FBBB628D0
** File Size: 544MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

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

=== Android 7.1.2 Stock Image [microSD Boot] [Rooted] [20171204] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 56520ED3DB6E587DA140AD314A055EB2
** File Size: 544MB

== Android TV 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD to eMMC] [v0.3.4-r86] by ayufan ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
* [https://github.com/ayufan-rock64/android-7.1/releases/tag/0.3.4 Release notes on ayufan Android 7.1 github]
* Please allow 5 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/android-7.1-rock-64-rock64_atv-v0.3.4-r86-raw_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 6FD1FA4BE87EC2D4E0862F66541BC6F0
** File Size: 716MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android TV 7.1 Community Build Image [eMMC] by ayufan ===
* For eMMC flash-all image, please unzip first and then use Android tool to flash in
** [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-update.zip]
* See [[ROCK64 MAC Address]] on how to set the MAC address.

== Android TV 7.x ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD Boot] by ayufan ===
* [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-raw.img.gz]

= Android SDK =

=== Android P SDK [v9.0] ===
* [https://files.pine64.org//SDK/ROCK64/ROCK64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 1EAC08942E238293E3AF11C7890DF307
** File Size: 104.34GB

[[Category:Rock64]]

Talk:ROCK64 Software Releases

2022-04-28T22:11:27Z

Diederik: Start discussion on the sequence of OS images, which seems random and inconsistent with the Rock64 page

I'm not sure how this 'Discussion' thing (should) work, but the sequence of the OS images seems rather random and is also not consistent with the 'Rock64' page itself.
Should that be fixed? And if so, how?

ROCK64

2022-04-28T22:05:04Z

Diederik: /* Quick Links to the Source of OS Images Build */ Replace outdated LibreELEC links with the official one

[[File:Rock64.jpg|400px|thumb|right|The ROCK64]]

The '''ROCK64''' is a credit-card size 4K60P HDR Media Board Computer powered by Rockchip RK3328 Quad-Core ARM Cortex A53 64-Bit Processor and supports up to 4GB 1866MHz LPDDR3 memory. It provides an eMMC module socket, MicroSD Card slot, Pi-2 Bus, Pi-P5+ Bus, USB 3.0, and many other peripheral interfaces for makers to integrate with sensors and other devices.

It supports many different open source operating systems, such as Android, Debian, and Yocto.

== Software releases ==
* OS build Installation Guide and tools:
** [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]
** [https://files.pine64.org/doc/rock64/tools/SD_Firmware_Tool._v1.46.zip Tools to burn Android build into a bootable microSD card]
** [https://files.pine64.org/doc/rock64/tools/AndroidTool_Release_v2.38.zip Tools that allows developer flash image into eMMC's Loader/Parameter/Misc/Kernal/Boot/Recovery/System/Backup partition]
** [https://files.pine64.org/doc/rock64/tools/DriverAssitant_v4.5.zip Windows ADB driver package]
** [[ROCK64 MAC Address]]

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

The list includes OS images and descriptions of:

* [[ROCK64_Software_Releases#Armbian|Armbian (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#AOSC|AOSC (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Manjaro ARM|Manjaro ARM (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Ubuntu 18.04 Bionic by ayufan|Ubuntu 18.04 Bionic by ayufan (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Slackware|Slackware (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#DietPi|DietPi (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#LibreELEC.28KODI.29|LibreElec for KODI (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Volumio 2 Digital Audio Player|Volumio 2 Digital Audio Player (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian|Debian Installer images (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian_by_ayufan|Debian by ayufan (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian_by_mrfixit2001|Debian by mrfixit2001 (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#OpenMediaVault|OpenMediaVault 64bit (microSD / eMMC boot)]]
* [[ROCK64_Software_Releases#NextCloudPi|NextCloudPi (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Recalbox|Recalbox (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#NetBSD|NetBSD (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Android_9.x_eMMC|Android 9.x (eMMC)]]
* [[ROCK64_Software_Releases#Android_8.x_eMMC|Android 8.x (eMMC)]] / [[ROCK64_Software_Releases#Android_8.x|Android 8.x (microSD Boot)]]
* [[ROCK64_Software_Releases#Android_7.x_eMMC|Android 7.x (eMMC)]] / [[ROCK64_Software_Releases#Android_7.x|Android 7.x (microSD Boot)]]
* [[ROCK64_Software_Releases#Android_TV_7.x_eMMC|Android TV 7.x (eMMC)]] / [[ROCK64_Software_Releases#Android_TV_7.x|Android TV 7.x (microSD Boot)]]

=== Quick Links to the Source of OS Images Build ===

Some OS images are still in '''beta or nightly build''' which are only fit for testing purposes. These should usually be avoided for normal usage, since they are '''used at your own risk'''.

* [https://github.com/ayufan-rock64/linux-build/releases/latest/ ayufan Linux]
* [https://github.com/ayufan-rock64/android-7.1/releases/latest/ ayufan Android 7.1]
* [https://github.com/LibreELEC/LibreELEC.tv LibreELEC (KODI)]
* [https://github.com/fire219/rock64-fedora/releases/latest/ Fire219 Fedora]
* [https://nightly.builds.lakka.tv/by_devices/RK3328.aarch64/ Lakka] | [https://github.com/rtissera/RetroPie-Setup/releases/latest/ RetroPie-Setup]
* [https://dl.armbian.com/rock64/ Armbian]
* [https://github.com/m01/rock64-arch-linux-build/releases/latest Arch Linux]
* [https://ownyourbits.com/downloads/ NextCloudPi]
* [https://dl.fail.pp.ua/slackware/images/rock64/ Slackware]
* [https://salsa.debian.org/installer-team/debian-installer/ Debian Installer]

=== State of Software Support for the Hardware ===

{| class="wikitable sortable"
! Requirement
! GNU/Linux
! Android/Linux
! Kodi/Linux

|-
| 2160p 30Hz 8bit h264/h265/vp8
| partial? [https://forum.pine64.org/showthread.php?tid=4861&pid=32474#pid32474 1]
| yes
| yes

|-
| UI using GPU
| no
| yes
| yes

|-
| Youtube
| no
| yes
| no

|-
| vp9 / mpeg4 / mpeg2 / 10bit HDR / YCbCr
| no
| yes?
| yes

|}

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
! scope="row" | Video Output
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchipdrm</code>
| With mpv, you'll need to specify something like <code>mpv --gpu-context=drm --drm-connector=1.HDMI-A-1</code> to get it to play back on a VT
|-
! scope="row" | 3D Acceleration
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>lima</code>
| Very recent version recommended for the best experience. Has weird glitches on HDMI output in weston.
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Broken/Not in ffmpeg
| <code>hantro_vpu</code> and <code>rockchip_vdec</code>, using <code>v4l2-requests</code>
| [https://lore.kernel.org/linux-media/49b1-608d4d00-2b-62afdf80@101971638/ Soon to be moved out of staging], ffmpeg patch set [https://patchwork.ffmpeg.org/project/ffmpeg/patch/20201209202513.27449-3-jonas@kwiboo.se/ seemingly abandoned], does not work on newer kernels. [https://github.com/Kwiboo/FFmpeg/commits/v4l2-request-hwaccel-master-stable Git branch with commits]
|-
! scope="row" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>snd_soc_rockchip_*</code>
|-
! scope="row" | Power Button
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk805_pwrkey</code>
| If your PWR switch does nothing unless held, this may need to be loaded manually with <code>modprobe</code> or by putting it in <code>/etc/modules-load.d/</code>
|-
! scope="row" | Analog Video Output
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip_drm_tve</code>
| Definitely needs some cleanup before it'd be ready for mainline, and needs some dt bindings written.
|}

== SoC and Memory Specification ==
* Based on [https://www.rock-chips.com/a/en/products/RK33_Series/2017/0118/829.html Rockchip RK3328]
[[File:Rockchip_RK3328.png|right]]

=== CPU Architecture ===
* [https://www.arm.com/products/processors/cortex-a/cortex-a53-processor.php Quad-core Cortex-A53 up to 1.5GHz CPU]
* Full implementation of the ARM architecture v8-A instruction set
* ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
* ARMv8 Cryptography Extensions
* In-order pipeline with symmetric dual-issue of most instructions
* Unified system L2 cache
* Includes VFP v3 hardware to support single and double-precision operations
* Integrated 32KB L1 instruction cache, 32KB 4-way set associative L1 data cache
* TrustZone technology support
* Full CoreSight debug solution
* One separate power domain for CPU core system to support internal power switch, and to externally turn on/off based on different application scenario
* PD_A53: Cortex-A53 + Neon + FPU + L1 I/D Cache of core 2/3
* One isolated voltage domain to support DVFS

==== Frequencies & Voltages ====

{| class="wikitable"
! Frequency
! Voltage
|- style="text-align:right;"
| 408 MHz
| 0.950 V
|- style="text-align:right;"
| 600 MHz
| 0.950 V
|- style="text-align:right;"
| 816 MHz
| 1.000 V
|- style="text-align:right;"
| 1008 MHz
| 1.100 V
|- style="text-align:right;"
| 1200 MHz
| 1.225 V
|- style="text-align:right;"
| 1296 MHz
| 1.300 V
|}

==== Power Draw ====

These numbers for power draw have been measured through an USB power monitor (FNB38) while running the <code>stress</code> utility, whereby "cpu" stands for <code>stress --cpu 4</code> and "vm" stands for <code>stress --vm 4</code>. The former spins on the CPU, the latter stresses the memory. Real workloads are usually a mix of both. The tests were ran through ssh, with nothing besides power and ethernet plugged into the ROCK64

Please keep in mind that under real world usage, many other factors come into play. Having a display connected, running a graphical session, I/O and most importantly the connected USB peripherals can add a lot.

Helpful refresher on the formula for power (W) on DC: power = current × voltage, because the power factor is 1. The ROCK64 runs on 5V, so use that to calculate current if you need to.

{| class="wikitable"
! Frequency
! Power cpu
! Power vm
|- style="text-align:right;"
| 1296 MHz
| 2.64 W
| 2.95 W
|- style="text-align:right;"
| 1200 MHz
| 2.32 W
| 2.69 W
|- style="text-align:right;"
| 1008 MHz
| 1.90 W
| 2.31 W
|- style="text-align:right;"
| 816 MHz
| 1.62 W
| 2.05 W
|- style="text-align:right;"
| 600 MHz
| 1.45 W
| 1.85 W
|- style="text-align:right;"
| 408 MHz
| 1.33 W
| 1.72 W
|- style="text-align:right;"
| Idle (no load)
|colspan="2" style="text-align:center;"| 1.10 W
|}

It appears a good upper bound for a headless setup is in the neighbourhood of 3 W, or the energy contained in 0.025 bananas per hour.

=== GPU Architecture ===
* [https://www.arm.com/products/multimedia/mali-gpu/ultra-low-power/mali-450.php ARM Mali-450MP2 Dual-core GPU]
* OpenGL ES 1.1 and 2.0, OpenVG1.1

=== System Memory ===
* LPDDR3 RAM Memory Variants: 1GB, 2GB and 4GB.

== Board Features ==
[[File:ROCK64_sideimg.jpg|400px|thumb|right|The ROCK64 and a size comparison]]

=== Video ===
* Digital Video output up to 4K@60Hz
* 4K HDR @ 60fps
* H.264/AVC Base/Main/High/High10 profile @ level 5.1; up to 4Kx2K @ 60fps
* H.265/HEVC Main/Main10 profile @ level 5.1 High-tier; up to 4Kx2K @ 60fps
* VP9, up to 4Kx2K @ 60fps
* MPEG-1, ISO/IEC 11172-2, up to 1080P @ 60fps
* MPEG-2, ISO/IEC 13818-2, SP@ML, MP@HL, up to 1080P @ 60fps
* MPEG-4, ISO/IEC 14496-2, SP@L0-3, ASP@L0-5, up to 1080P @ 60fps
* VC-1, SP@ML, MP@HL, AP@L0-3, up to 1080P @ 60fps
* MVC is supported based on H.264 or H.265, up to 1080P @ 60fps

=== Audio ===
* 3.5mm A/V Jack (Composite Video Output and RCA Stereo support using conversion cable)

=== Network ===
* 10/100/1000Mbps Ethernet
* WiFi 802.11 b/g/n with Bluetooth 4.0 (optional USB dongle)

=== Storage ===
* microSD - bootable, supports SDHC and SDXC and storage up to 256GB
* eMMC - bootable (optional eMMC Module)
* 128Mbit (16MB) on-board SPI flash memory (empty by default) - bootable? Usually accessible as a [http://linux-mtd.infradead.org/doc/general.html Linux MTD] device at <code>/dev/mtd0</code>
* 1 USB3.0 Dedicated Host port
* 2 USB2.0 Dedicated Host port (top one is USB-OTG)

=== Expansion Ports ===
All GPIO pins, including UART, operate at 3.3V. (See VCCIO5 in the schematics.)

* 2x20 pins "Pi2" GPIO Header
* 2x11 pins "Pi P5+" GPIO Header (with 2nd 10/100Mbps Ethernet pins)

== ROCK64 Board Information, Schematics and Certifications ==
* Board Dimensions: 85mm x 56mm x 18.8mm
** [https://files.pine64.org/doc/rock64/rock64%20board%20dimension.pdf ROCK64 board dimension drawing]
* Input Power: +5V @3A with 3.5mm/1.35mm Type H Barrel type DC connector (@2A will work if there is no heavy load on the USB 3.0 port)
* ROCK64 ver 3.0 SBC related info
** [https://files.pine64.org/doc/rock64/Rock64%20Ver%203%20change%20notice.pdf ROCK64 SBC v3.0 Change Notice]
** [https://files.pine64.org/doc/rock64/ROCK64_Schematic_v3.0_20181105.pdf ROCK64 Schematic v3.0 (Production Release)]
** [https://files.pine64.org/doc/rock64/ROCK64_comp_ref_top_v3.0_20181105.pdf ROCK64 Component Reference location v3.0 (top layer)]
** [https://files.pine64.org/doc/rock64/ROCK64_comp_ref_bottom_v3.0_20181105.pdf ROCK64 Component Reference location v3.0 (bottom layer)]
** [https://files.pine64.org/doc/rock64/ROCK64_V3_Pi-2_and_Pi-P5+_Bus.pdf ROCK64 SBC v3.0 Pi-2 and Pi-P5+ Bus GPIO Assignment]
* [https://files.pine64.org/doc/rock64/R64V3%20RTC%20Batt%20connector.png ROCK64 Rev3 SBC RTC Battery Connector polarity]
* ROCK64 ver 2.0 SBC related info
** [https://files.pine64.org/doc/rock64/ROCK64_Schematic_v2.0_20171019.pdf ROCK64 Schematic v2.0 (Production Release)]
** [https://files.pine64.org/doc/rock64/ROCK64_Pi-2%20_and_Pi_P5+_Bus.pdf ROCK64 SBC v2.0 Pi-2 and Pi-P5+ Bus GPIO Assignment]
* [https://github.com/Leapo/Rock64-R64.GPIO Github on ROCK64 GPIO library, thanks to Leapo]
* [http://synfare.com/599N105E/hwdocs/rock64/index.html Good documentation about ROCK64 GPIO pins article]
* [https://files.pine64.org/doc/rock64/ROCK64_ES9023_Audio_100Mbps_Ethernet_Board.pdf ROCK64 Audio DAC with 10/100Mbps Ethernet POT Board Schematic]
* ROCK64 3-D autodesk drawing, thanks and courtesy of TeaPack
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e818b9e1b31b54545?viewState=NoIgbgDAdAjCA0IAsSDMAzAnAQwCaoFoYBjAdhgICNTVcCA2S9AJgIFMJTsAOGTU3LmLYQAXSA ROCK64 board 2D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e6078b748ecd478e1?viewState=NoIgbgDAdAjCA0IDeAdEAXAngBwKZoC40ARXAZwEsBzAOzXjQEMyzd1C0AmAEwGYZOAI0G4AtAA4ArABZeo6eIiNRggJwxuomAHYAxoOm6YMaQDZOvNAF8QAXSA ROCK64 board 3D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e45a87155aecc813f?viewState=NoIgbgDAdAjCA0IDeAdEAXAngBwKZoC40ARXAZwEsBzAOzXjQEMyzd1C0BWAYwgGYYAEyEBaQQDYARoJEAWfjMmzckkQCYAHCs5LZAMxi41aAL4gAukA ROCK64 Audio DAC with 10/100Mbps Ethernet POT board 3D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761ee09b497ae3f2f72e?viewState=NoIgbgDAdAjCA0IBmSYEMAcBmAbBgtACwBGhMRATMeQKYYYX5ICcAJhjYWjDBGgKwgAukA ROCK64 board with Audio DAC POT board 3D drawing @courtesy of TeaPack]
* ROCK64 Certifications:
** Disclaimer: Please note that PINE64 SBC is not a "final" product and in general certification is not necessary. However, PINE64 still submits the SBC for FCC, CE, and ROHS certifications and obtain the certificates to prove that the SBC board can pass the testing. Please note, a final commercial product needs to perform its own testing and obtain its own certificate.
** [https://files.pine64.org/doc/cert/ROCK64%20FCC%20certification%20VOC20171129.pdf ROCK64 FCC Certificate]
** [https://files.pine64.org/doc/cert/ROCK64%20CE%20certification%20VOC20171129.pdf ROCK64 CE Certificate]
** [https://files.pine64.org/doc/cert/ROCK64%20ROHS%20certification%20VOC20170927.pdf ROCK64 RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3328 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2017/0118/829.html Rockchip RK3328 SoC Brief]
** [https://rockchip.fr/RK3328%20datasheet%20V1.2.pdf Rockchip RK3328 Datasheet V1.2]
** [https://opensource.rock-chips.com/images/9/97/Rockchip_RK3328TRM_V1.1-Part1-20170321.pdf Rockchip RK3328 Technical Reference Manual part 1]
** [https://files.pine64.org/doc/rock64/Rockchip_RK805_Datasheet_V1.1%C2%A020160921.pdf Rockchip RK805 Datasheet V1.1]
* LPDDR3 (178 Balls) SDRAM:
** [https://files.pine64.org/doc/rock64/H9CCNNNCLTMLAR(Rev1.2).pdf Hynix LPDDR3 Datasheet V1.2]
** [https://files.pine64.org/doc/rock64/K4E8E324EB-EGCF000_DRAM_178F_11x11.5_Ver.1.00.00.pdf Samsung LPDDR3 Datasheet V1.00.00]
** [https://files.pine64.org/doc/rock64/SPECTEK_178B_32GB_V91M_MOBILE_LPDDR3.pdf Spectek LPDDR3 Datasheet]
* eMMC information:
** [https://files.pine64.org/doc/rock64/PINE64_eMMC_Module_20170719.pdf PINE64 eMMC module schematic]
** [https://files.pine64.org/doc/rock64/usb%20emmc%20module%20adapter%20v2.pdf PINE64 USB adapter for eMMC module V2 schematic]
** [https://files.pine64.org/doc/rock64/USB%20adapter%20for%20eMMC%20module%20PCB.tar PINE64 USB adapter for eMMC module PCB in JPEG]
** [https://files.pine64.org/doc/datasheet/pine64/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]
* Ethernet related info:
** [https://files.pine64.org/doc/datasheet/rock64/RTL8211F-CG-Realtek.pdf Realtek RTL8211F 10/100/1000M Ethernet Transceiver Datasheet]
** [https://files.pine64.org/doc/rock64/DGKYD111B096GWA1D.pdf 10/100Mbps MegJack on Audio DAC POT board Datasheet]
* Peripheral related info:
** [https://files.pine64.org/doc/rock64/PDS-16002%20JMS578%20Datasheet%20(Rev.%201.01).pdf JMicron JMS578 to SATA Datasheet]
* Enclosure information:
** [https://files.pine64.org/doc/datasheet/case/ROCK64%20Aluminum%20Waterproof%20Die%20Cast%20Casing.pdf Outdoor Aluminum Cast Dust-proof IP67 Enclosure Drawing]
* Remote control button mapping
** [https://files.pine64.org/doc/Pine%20A64%20Schematic/remote-wit-logo.jpg Official Remote Control for the PINE A64 Button Mapping]

== Enclosures ==

[[File:Rock64-Al-Case1-1.jpg|thumb|100px]]

The ROCK64 fits in three officially sold cases.

* [["Model B" Acrylic Open Enclosure]], [https://pine64.com/product/model-b-acrylic-open-enclosure/ Store]
* [["Model B" Aluminum Waterproof Enclosure]], [https://pine64.com/product/model-b-aluminum-waterproof-enclosure/ Store]
* [[ROCK64 Premium Aluminum Casing]], [https://pine64.com/product/model-b-premium-aluminum-casing/?v=0446c16e2e66 Store]

== Troubleshooting ==

=== HDMI output disconnects as soon as it connects ===

Some older monitors seemingly can get into a weird state wherein the ROCK64 is unable to establish a proper connection with them. [[User:CounterPillow]] has seen this happen on an iiyama ProLite G2773HS connected over HDMI, and an Acer P225HQL connected over an HDMI to DVI adapter. The symptoms usually are that you see the monitor briefly turn on its backlight without displaying a picture, but then immediately either shutting off again or showing a "No Signal" message.

The solution is to completely power down your ROCK64, also removing its power source. Then plug in the monitor, and start up the ROCK64 afterwards. You should now be getting a picture again.

=== Power button doesn't do anything on a short press (Linux) ===

Make sure the <code>rk805_pwrkey</code> module is loaded, e.g. with <code>lsmod | grep rk805_pwrkey</code>. If it doesn't show up, do a <code>modprobe rk805_pwrkey</code> as root. To make this persistent, create a <code>99-rk805_pwrkey.conf</code> in <code>/etc/modules-load.d/</code> with the content <code>rk805_pwrkey</code>

If it still doesn't work, make sure your init system is actually listening to the button press. With systemd, check <code>/etc/systemd/logind.conf</code> and make sure it's either all commented out (uses defaults) or contains something like <code>HandlePowerKey=poweroff</code>. You can change the short press action by setting <code>HandlePowerKey</code> to one of "ignore", "poweroff", "reboot", "halt", "kexec", "suspend", "hibernate", "hybrid-sleep", "suspend-then-hibernate", or "lock".

== Other Resources ==
* [https://forum.pine64.org/forumdisplay.php?fid=85 ROCK64 Forum]
* IRC Server: irc.pine64.org Channel: ROCK64
* [https://github.com/rock64-linux ROCK64 Linux GitHub Repo]
* [https://github.com/ayufan-rock64 ROCK64 ayufan GitHub Repo]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://github.com/JamesLinEngineer/RKMC Rockchip Android RKMC (Forked from Kodi 16.1)]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [https://wiki.pine64.org/index.php/Rock64_Guides ROCK64 Guides]
* [https://www.armbian.com/rock64 Armbian's ROCK64 Page]

[[Category:Rock64]] [[Category:Rockchip RK3328]]

ROCK64 Software Releases

2022-04-28T22:02:24Z

Diederik: /* LibreELEC(KODI) */ Fix DL link and minor spelling/spacing issues. Also add daily build info/link

This page contains a list of all available releases for the [[ROCK64]], as well as links to other resources.

= Linux Image Releases =

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

* Version 5.88 onward support Rock64-v3 board
* To find out more about Armbian and available options please visit their [https://www.armbian.com/rock64/ site]
* Armbian pack as 7zip, please unzip first before dd.
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]

=== Armbian Ubuntu Focal XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal XFCE Desktop download site]

=== Armbian Ubuntu Bionic XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Bionic XFCE DEsktop download site]
* Login with
** username: root
** password: 1234

=== Armbian Debian Buster for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Debian Buster
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Debian Buster download site]

=== Armbian Ubuntu Focal for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Ubuntu Focal
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal download site]

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

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

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

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

=== AOSC Cinnamon Community Build Image [microSD and eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/rockchip64/cinnamon/rock64/ Direct download from AOSC]

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

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

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

Manjaro editions for Rock64 are available directly from Manjaro.

[https://manjaro.org/download/#rock64 Manjaro Rock64 Download Page]

* '''Only support ROCK64 ver2 SBC'''
* To learn more about Manjaro please visit [https://forum.manjaro.org/tags/manjaroarm Manjaro Forum]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]

== Ubuntu 18.04 Bionic by ayufan ==
[[File:penguin.png|right|100px]]

* [https://github.com/ayufan-rock64/linux-build/releases ayufan ROCK64 Linux Build GitHub]
* Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* Login with
** username: rock64
** password: rock64

=== Ubuntu 18.04 Bionic LXDE Desktop (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-lxde-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 64bit (arm64) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 32bit (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic containers (DockerCE & Kubernetes) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-containers-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

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

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

=== Slackware Aarch64 XFCE Community Build Image [microSD Boot] ===
* System with a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-xfce-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

=== Slackware Aarch64 Miniroot Community Build Image [microSD Boot] ===
* System without a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-base-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

* To run the OS on eMMC
**Flash the image to micro SD, power up the board with micro SD and login
**Copy the image file to micro SD by using SFTP. The image file must be in .img. ''note : root user are not allow transfer file to micro SD.''
**After finish copy the file, power off the board and add eMMC module to the board
**Bootup the board, run below command for flashing to eMMC module
***>>dd if=[image file] of=/dev/mmcblk1 bs=10M
****''example : dd if=slack-current-aarch64-xfce_08May18-4.4.126-rock64-build-20180508.img of=/dev/mmcblk1 bs=10M''
***then edit 2 files in eMMC module:
***>> mount /dev/mmcblk1p1 /media
***>> echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt
***>> sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab
**After done, power off board and remove micro SD. Then bootup with only eMMC module.

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

== LibreELEC (KODI) ==
[[File:libreelec.jpg|right|100px]]

=== Official LibreElEC KODI Build Image [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://libreelec.tv/downloads/rockchip/ Direct download from LibreElec site and look for PINE64 LibreELEC-RK3328.arm-x.x.x-rock64.img.gz]

=== Daily Build images (for testing) [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://test.libreelec.tv/ Direct download from LibreElec site and put 'rock64' in the search box]

== Volumio 2 Digital Audio Player ==
[[File:volumio.png|right|100px]]

* Volumio is a linux-based headless DAP (digital audio player), which connects to your home stereo system or your DAC
* Visit the project's website [https://community.volumio.org/t/volumio-2-on-rock64/8192 here]
* You can follow the ongoing discussion about Volumio on the [https://forum.pine64.org/showthread.php?tid=5322 PINE64 forum]

=== Volumio Digital Audio Player Community Build Image [microSD Boot] [2.528-2019-01-12] ===
* DD image (for 8GB microSD card and above)
** [https://updates.volumio.org/rock64/volumio/2.861/volumio-2.861-2020-12-22-rock64.img.zip Direct download from volumio.org]
* Login with
** Username: volumio
** Password: volumio
* '''Volumio is controlled using a Web-GUI which can be accessed via a web browser using the boards IP or volumio.local/'''

== Lakka ==
[[File:lakka.png|right|100px]]

=== Lakka Community Build Image [microSD / eMMC Boot] ===
* [https://www.lakka.tv/ Lakka] The open source game console; a lightweight Linux distribution that transforms the Rock64 into a full blown retrogaming console
* Visit [https://forum.pine64.org/showthread.php?tid=5354 PINE64 forum] for more information about the Lakka release
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://le.builds.lakka.tv/legacy-2.3/Rockchip.ROCK64.arm/ Direct download from Lakka]
* [[Lakka|Lakka Basic Setup]]

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

=== Debian Installer - Bullseye ===
* Go to Debian Bullseye's [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-bullseye-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and connect a serial console and boot up to start the Debian Installer

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

=== Debian Installer - Daily Build (for Bookworm+) ===
* Go to Debian's daily build [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-daily-build-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and boot up to start the Debian Installer. It should work with both a [bugs.debian.org/1009014 normal display as a serial console]

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

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

=== Debian Stretch Minimal 64bit (arm64) OS Image [microSD / eMMC Boot] [0.8.3] ===
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-minimal-rock64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 212MB
* Login with
** username: rock64
** password: rock64
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309&pid=39314#pid39314 here]

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

=== Minimal Debian [microSD / eMMC Boot] ===
** DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/mrfixit2001/debian_builds/releases Direct download from mrfixit2001's github]
** Version 190514 onward support Rock64-v3 board
* Login with
** username: rock
** password: rock

== OpenMediaVault ==
[[File:omv.png|right|100px]]

=== Jessie OpenMediaVault Community Build Image [microSD to eMMC] [0.5.15-136] by ayufan ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page]
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
'''* There's a bug with eMMC in the "Stable" version of openmediavault linked from the wiki page. In order to use eMMC, please you need to be on the latest (pre-release) version which is linked here https://github.com/ayufan-rock64/linux-build/releases'''
*
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github]
* [https://files.pine64.org/os/ROCK64/omv/jessie-openmediavault-rock64-0.5.15-136-armhf_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7E423EF9146EA15403E7D1B4EA30594A
** File Size: 487MB
** Credentials (console/ssh, except OMV): rock64/rock64
** Credentials (OMV for Web): admin/openmediavault
** Credentials (OMV for console): root/openmediavault
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

=== Stretch OpenMediaVault OS Image 32bit (armhf) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rock64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
** size: 391MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

=== Stretch OpenMediaVault OS Image 64bit (arm64) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 340MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

== NextCloudPi==
[[File:nextcloudpi.png|right|100px]]

=== NextCloudPi Community Build Image [microSD / eMMC Boot] [03-10-19] ===
* NextCloudPi comes not only with NextCloud preinstalled, but also with management tools for backups, SSL certificates, SAMBA, enhanced security and more.
* Visit the project's [https://nextcloudpi.com website]
* You can follow the ongoing discussion about NextCloudPi on the [https://forum.pine64.org/showthread.php?tid=6047 PINE64 forum]
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://files.pine64.org/os/ROCK64/nextcloudplus/NextCloudPi_Rock64_03-10-19.img.xz Direct download from pine64.org]
*** MD5 (XZ file): 1432c8b8082696f38770004b3cb5ac1e
*** File Size: 310MB
* Login with
** username: root
** password: 1234

== Recalbox ==
[[File:RB.png|right|100px]]

=== Recalbox Community Build Image [microSD / eMMC boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Recalbox allows you to re-play a variety of videogame consoles and platforms in your living room, with ease!
* To find out more about Recalbox and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7111 PINE64 forum thread]
*Visit the project's [https://www.recalbox.com/ website]
* DD image (for 8GB microSD card and above)
** [https://github.com/mrfixit2001/recalbox_rock64/releases Direct download latest release build from mrfixit2001 github]

== Cent OS [No Longer Maintained] ==
[[File:Centos.png|right|100px]]

=== CentOS-7 Community Build Image [microSD Boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Centos-7.4.1708 with kernel from Armbian-5.69 (minimum build)
** DD image (for 8GB microSD card and above)
** [https://github.com/Project31/centos-pine64/releases/download/v7.4.1708-v5.59/centos7-rock64.img.xz Project31 download mirrors]
* To find out more on installation process, please visit their [https://project31.github.io/pine64/ Project31 site]
* Login with
** username: root
** password: centos

== NEMS Linux ==
[[File:nems.jpg|right|100px]]

https://files.pine64.org/sw/pine64_installer/json/nems.jpg
* '''Only support ROCK64 ver2 SBC'''
* NEMS stands for "Nagios Enterprise Monitoring Server" and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers.
* To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread]
* Login with
** Username: nemsadmin
** Password: nemsadmin
* [https://docs.nemslinux.com/installation Installation Guide]
* To find out more on NEM Linux, please visit their [https://nemslinux.com/ site]

=== NEMS Linux [microSD / eMMC boot] [v1.5 - build 2] ===
* DD image (for 16GB microSD card and above)
** [https://nemslinux.com/download/nagios-for-pine64.php Download torrent seed from NEMS Linux]
** [https://files.pine64.org/os/ROCK64/nems/NEMS_v1.5-Rock64-Build2.zip Direct download from pine64.org]
*** MD5 (XZ file): 6e2088922c5d197db8b8ba3057120389
*** File Size: 1.30GB

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

=== Fedora Minimal Community Build Image [microSD boot] [Preliminary Build] ===
* [https://github.com/fire219/rock64-fedora/releases/ Follow up on Fire219 github]

= BSD Image Releases =

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

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

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

* You can install OpenBSD on your Rock64 by following [https://github.com/krjdev/rock64_openbsd these instructions]
 

==FreeBSD==
<div style=float:right>[[File:Freebsd_Logo.png|right|100px]]</div>
The [https://wiki.freebsd.org/arm/RockChip#Rock64 RockChip FreeBSD page] has instructions for installing FreeBSD.

* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]
* Version 13.0 and greater include prebuilt images. Find the link in the SD Card Images section and download the ROCK64 image.
* SSH is enable by default and can be accessed with the following account:
:: username: freebsd
:: password: freebsd
* The root account credentials are:
:: username: root
:: password: root

= Android Image Releases =

== Android TV 9.x eMMC (No Google Play) ==
[[File:android_9.png|right|100px]]

'''* For install Playstore on Android 9.0, please follows [https://forum.pine64.org/showthread.php?tid=8655 this forum thread]'''

=== Android 9.0 Stock Image [eMMC Boot] using DD method [20190617] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D985808B4CA912201372DC2F5F322AE9
*** File Size: 560MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5D65A44F78BD08B4584413C8BEEAAF05
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): B34D1C119386CBA1658E5F0FB9E4413D
*** File Size: 615MB

=== Android 9.0 Stock Image [eMMC Boot] using ROCKChip tools method [20190617] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Android TV build version
** [https://files.pine64.org/os/ROCK64/android/ROCK64_20190617_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 9B717263E7749A732C8B5C7D7D59C5C6
*** File Size: 544MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using DD method [20190618] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): DBB5B3D46B77A33BC9F09173C9788E6E
*** File Size: 561MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5F3B97EA72B3227082500B3FB1FAB44A
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 6833B124ABA3AC2269A6B4F51EFD1109
*** File Size: 615MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using ROCKChip tools method [20190618] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190618_stock_rooted_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): FC5F80C3A939AD0F8DCE5B85F22D20A1
** File Size: 544MB

== Android 9.x (No Google Play) ==
[[File:android_9.png|right|100px]]

=== Android 9.0 Stock Rooted Image [microSD Boot] using DD method [20190621] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* DD image for 8GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): A250B72CD6AAB24B8156DE08EB15530C
*** File Size: 546MB
* DD image for 16GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09A6BACD71159853D5E4C6C21C883B0F
*** File Size: 556MB
* DD image for 32GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): C68DC5D96F1C546B96EC690CE7BFE910
*** File Size: 574MB
* DD image for 64GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4EFC87B4CEE4C7655618DCA95EF7DD0D
*** File Size: 707MB

=== Android 9.0 Stock Rooted Image [microSD Boot] using ROCKChip SDDisk tools method [20190621] ===
* Please unzip first and then using Android tool to flash in
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://files.pine64.org/os/ROCK64/android/SDDiskTool_v1.57.zip Rockchip SDDisk Tool ver 1.57]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190621_stock_rooted_android_9.0_sdboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): EE00D309745F842213E21B2F1E20C510
** File Size: 539MB

== Android 8.x TV eMMC (preinstalled Google Play Store) ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [eMMC Boot] using DD method [20180606] ===
* DD image to eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180606_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): C05846B89A6483DA911CEA604627524F
** File Size: 561MB

=== Android 8.1. Stock Image [eMMC Boot] using ROCKChip tools method [20180606] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/rock64_android8.1_emmc_boot_v1.1.zip Direct download from pine64.org]
** MD5 (XZ file): 9738F060D2F62A83637797363D2B38C9
** File Size: 752MB

== Android 8.x TV ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [microSD Boot] [20180623] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180623_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 85372A568C114ADE7CD9632CEBA193E9
** File Size: 575MB

== Android 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android 7.1.2 Stock Image [microSD to eMMC] [Rooted] [20171204] ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper, then it will start writing the new image to the eMMC. Please allow around 1 minute of boot up time before UI is presented via HDMI
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 43443467DFCAEDE767556843EB4D6707
** File Size: 558MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android 7.1.2 Stock Image [eMMC Boot] [Rooted] [20171204] ===
* Please unzip first and then using Android tool to flash in
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7C831F9E6B4311A3B3D4743FBBB628D0
** File Size: 544MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

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

=== Android 7.1.2 Stock Image [microSD Boot] [Rooted] [20171204] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 56520ED3DB6E587DA140AD314A055EB2
** File Size: 544MB

== Android TV 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD to eMMC] [v0.3.4-r86] by ayufan ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
* [https://github.com/ayufan-rock64/android-7.1/releases/tag/0.3.4 Release notes on ayufan Android 7.1 github]
* Please allow 5 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/android-7.1-rock-64-rock64_atv-v0.3.4-r86-raw_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 6FD1FA4BE87EC2D4E0862F66541BC6F0
** File Size: 716MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android TV 7.1 Community Build Image [eMMC] by ayufan ===
* For eMMC flash-all image, please unzip first and then use Android tool to flash in
** [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-update.zip]
* See [[ROCK64 MAC Address]] on how to set the MAC address.

== Android TV 7.x ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD Boot] by ayufan ===
* [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-raw.img.gz]

= Android SDK =

=== Android P SDK [v9.0] ===
* [https://files.pine64.org//SDK/ROCK64/ROCK64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 1EAC08942E238293E3AF11C7890DF307
** File Size: 104.34GB

[[Category:Rock64]]

ROCK64

2022-04-28T21:53:56Z

Diederik: Add source for Debian Installer

[[File:Rock64.jpg|400px|thumb|right|The ROCK64]]

The '''ROCK64''' is a credit-card size 4K60P HDR Media Board Computer powered by Rockchip RK3328 Quad-Core ARM Cortex A53 64-Bit Processor and supports up to 4GB 1866MHz LPDDR3 memory. It provides an eMMC module socket, MicroSD Card slot, Pi-2 Bus, Pi-P5+ Bus, USB 3.0, and many other peripheral interfaces for makers to integrate with sensors and other devices.

It supports many different open source operating systems, such as Android, Debian, and Yocto.

== Software releases ==
* OS build Installation Guide and tools:
** [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]
** [https://files.pine64.org/doc/rock64/tools/SD_Firmware_Tool._v1.46.zip Tools to burn Android build into a bootable microSD card]
** [https://files.pine64.org/doc/rock64/tools/AndroidTool_Release_v2.38.zip Tools that allows developer flash image into eMMC's Loader/Parameter/Misc/Kernal/Boot/Recovery/System/Backup partition]
** [https://files.pine64.org/doc/rock64/tools/DriverAssitant_v4.5.zip Windows ADB driver package]
** [[ROCK64 MAC Address]]

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

The list includes OS images and descriptions of:

* [[ROCK64_Software_Releases#Armbian|Armbian (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#AOSC|AOSC (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Manjaro ARM|Manjaro ARM (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Ubuntu 18.04 Bionic by ayufan|Ubuntu 18.04 Bionic by ayufan (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Slackware|Slackware (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#DietPi|DietPi (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#LibreELEC.28KODI.29|LibreElec for KODI (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Volumio 2 Digital Audio Player|Volumio 2 Digital Audio Player (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian|Debian Installer images (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian_by_ayufan|Debian by ayufan (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian_by_mrfixit2001|Debian by mrfixit2001 (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#OpenMediaVault|OpenMediaVault 64bit (microSD / eMMC boot)]]
* [[ROCK64_Software_Releases#NextCloudPi|NextCloudPi (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Recalbox|Recalbox (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#NetBSD|NetBSD (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Android_9.x_eMMC|Android 9.x (eMMC)]]
* [[ROCK64_Software_Releases#Android_8.x_eMMC|Android 8.x (eMMC)]] / [[ROCK64_Software_Releases#Android_8.x|Android 8.x (microSD Boot)]]
* [[ROCK64_Software_Releases#Android_7.x_eMMC|Android 7.x (eMMC)]] / [[ROCK64_Software_Releases#Android_7.x|Android 7.x (microSD Boot)]]
* [[ROCK64_Software_Releases#Android_TV_7.x_eMMC|Android TV 7.x (eMMC)]] / [[ROCK64_Software_Releases#Android_TV_7.x|Android TV 7.x (microSD Boot)]]

=== Quick Links to the Source of OS Images Build ===

Some OS images are still in '''beta or nightly build''' which are only fit for testing purposes. These should usually be avoided for normal usage, since they are '''used at your own risk'''.

* [https://github.com/ayufan-rock64/linux-build/releases/latest/ ayufan Linux]
* [https://github.com/ayufan-rock64/android-7.1/releases/latest/ ayufan Android 7.1]
* [https://github.com/Raybuntu/LibreELEC.tv/releases/latest/ Raybuntu LibreElec KODI] | [https://github.com/Kwiboo/LibreELEC.tv/releases/latest/ Kwiboo LibreElec KODI]
* [https://github.com/fire219/rock64-fedora/releases/latest/ Fire219 Fedora]
* [https://nightly.builds.lakka.tv/by_devices/RK3328.aarch64/ Lakka] | [https://github.com/rtissera/RetroPie-Setup/releases/latest/ RetroPie-Setup]
* [https://dl.armbian.com/rock64/ Armbian]
* [https://github.com/m01/rock64-arch-linux-build/releases/latest Arch Linux]
* [https://ownyourbits.com/downloads/ NextCloudPi]
* [https://dl.fail.pp.ua/slackware/images/rock64/ Slackware]
* [https://salsa.debian.org/installer-team/debian-installer/ Debian Installer]

=== State of Software Support for the Hardware ===

{| class="wikitable sortable"
! Requirement
! GNU/Linux
! Android/Linux
! Kodi/Linux

|-
| 2160p 30Hz 8bit h264/h265/vp8
| partial? [https://forum.pine64.org/showthread.php?tid=4861&pid=32474#pid32474 1]
| yes
| yes

|-
| UI using GPU
| no
| yes
| yes

|-
| Youtube
| no
| yes
| no

|-
| vp9 / mpeg4 / mpeg2 / 10bit HDR / YCbCr
| no
| yes?
| yes

|}

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
! scope="row" | Video Output
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchipdrm</code>
| With mpv, you'll need to specify something like <code>mpv --gpu-context=drm --drm-connector=1.HDMI-A-1</code> to get it to play back on a VT
|-
! scope="row" | 3D Acceleration
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>lima</code>
| Very recent version recommended for the best experience. Has weird glitches on HDMI output in weston.
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Broken/Not in ffmpeg
| <code>hantro_vpu</code> and <code>rockchip_vdec</code>, using <code>v4l2-requests</code>
| [https://lore.kernel.org/linux-media/49b1-608d4d00-2b-62afdf80@101971638/ Soon to be moved out of staging], ffmpeg patch set [https://patchwork.ffmpeg.org/project/ffmpeg/patch/20201209202513.27449-3-jonas@kwiboo.se/ seemingly abandoned], does not work on newer kernels. [https://github.com/Kwiboo/FFmpeg/commits/v4l2-request-hwaccel-master-stable Git branch with commits]
|-
! scope="row" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>snd_soc_rockchip_*</code>
|-
! scope="row" | Power Button
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk805_pwrkey</code>
| If your PWR switch does nothing unless held, this may need to be loaded manually with <code>modprobe</code> or by putting it in <code>/etc/modules-load.d/</code>
|-
! scope="row" | Analog Video Output
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip_drm_tve</code>
| Definitely needs some cleanup before it'd be ready for mainline, and needs some dt bindings written.
|}

== SoC and Memory Specification ==
* Based on [https://www.rock-chips.com/a/en/products/RK33_Series/2017/0118/829.html Rockchip RK3328]
[[File:Rockchip_RK3328.png|right]]

=== CPU Architecture ===
* [https://www.arm.com/products/processors/cortex-a/cortex-a53-processor.php Quad-core Cortex-A53 up to 1.5GHz CPU]
* Full implementation of the ARM architecture v8-A instruction set
* ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
* ARMv8 Cryptography Extensions
* In-order pipeline with symmetric dual-issue of most instructions
* Unified system L2 cache
* Includes VFP v3 hardware to support single and double-precision operations
* Integrated 32KB L1 instruction cache, 32KB 4-way set associative L1 data cache
* TrustZone technology support
* Full CoreSight debug solution
* One separate power domain for CPU core system to support internal power switch, and to externally turn on/off based on different application scenario
* PD_A53: Cortex-A53 + Neon + FPU + L1 I/D Cache of core 2/3
* One isolated voltage domain to support DVFS

==== Frequencies & Voltages ====

{| class="wikitable"
! Frequency
! Voltage
|- style="text-align:right;"
| 408 MHz
| 0.950 V
|- style="text-align:right;"
| 600 MHz
| 0.950 V
|- style="text-align:right;"
| 816 MHz
| 1.000 V
|- style="text-align:right;"
| 1008 MHz
| 1.100 V
|- style="text-align:right;"
| 1200 MHz
| 1.225 V
|- style="text-align:right;"
| 1296 MHz
| 1.300 V
|}

==== Power Draw ====

These numbers for power draw have been measured through an USB power monitor (FNB38) while running the <code>stress</code> utility, whereby "cpu" stands for <code>stress --cpu 4</code> and "vm" stands for <code>stress --vm 4</code>. The former spins on the CPU, the latter stresses the memory. Real workloads are usually a mix of both. The tests were ran through ssh, with nothing besides power and ethernet plugged into the ROCK64

Please keep in mind that under real world usage, many other factors come into play. Having a display connected, running a graphical session, I/O and most importantly the connected USB peripherals can add a lot.

Helpful refresher on the formula for power (W) on DC: power = current × voltage, because the power factor is 1. The ROCK64 runs on 5V, so use that to calculate current if you need to.

{| class="wikitable"
! Frequency
! Power cpu
! Power vm
|- style="text-align:right;"
| 1296 MHz
| 2.64 W
| 2.95 W
|- style="text-align:right;"
| 1200 MHz
| 2.32 W
| 2.69 W
|- style="text-align:right;"
| 1008 MHz
| 1.90 W
| 2.31 W
|- style="text-align:right;"
| 816 MHz
| 1.62 W
| 2.05 W
|- style="text-align:right;"
| 600 MHz
| 1.45 W
| 1.85 W
|- style="text-align:right;"
| 408 MHz
| 1.33 W
| 1.72 W
|- style="text-align:right;"
| Idle (no load)
|colspan="2" style="text-align:center;"| 1.10 W
|}

It appears a good upper bound for a headless setup is in the neighbourhood of 3 W, or the energy contained in 0.025 bananas per hour.

=== GPU Architecture ===
* [https://www.arm.com/products/multimedia/mali-gpu/ultra-low-power/mali-450.php ARM Mali-450MP2 Dual-core GPU]
* OpenGL ES 1.1 and 2.0, OpenVG1.1

=== System Memory ===
* LPDDR3 RAM Memory Variants: 1GB, 2GB and 4GB.

== Board Features ==
[[File:ROCK64_sideimg.jpg|400px|thumb|right|The ROCK64 and a size comparison]]

=== Video ===
* Digital Video output up to 4K@60Hz
* 4K HDR @ 60fps
* H.264/AVC Base/Main/High/High10 profile @ level 5.1; up to 4Kx2K @ 60fps
* H.265/HEVC Main/Main10 profile @ level 5.1 High-tier; up to 4Kx2K @ 60fps
* VP9, up to 4Kx2K @ 60fps
* MPEG-1, ISO/IEC 11172-2, up to 1080P @ 60fps
* MPEG-2, ISO/IEC 13818-2, SP@ML, MP@HL, up to 1080P @ 60fps
* MPEG-4, ISO/IEC 14496-2, SP@L0-3, ASP@L0-5, up to 1080P @ 60fps
* VC-1, SP@ML, MP@HL, AP@L0-3, up to 1080P @ 60fps
* MVC is supported based on H.264 or H.265, up to 1080P @ 60fps

=== Audio ===
* 3.5mm A/V Jack (Composite Video Output and RCA Stereo support using conversion cable)

=== Network ===
* 10/100/1000Mbps Ethernet
* WiFi 802.11 b/g/n with Bluetooth 4.0 (optional USB dongle)

=== Storage ===
* microSD - bootable, supports SDHC and SDXC and storage up to 256GB
* eMMC - bootable (optional eMMC Module)
* 128Mbit (16MB) on-board SPI flash memory (empty by default) - bootable? Usually accessible as a [http://linux-mtd.infradead.org/doc/general.html Linux MTD] device at <code>/dev/mtd0</code>
* 1 USB3.0 Dedicated Host port
* 2 USB2.0 Dedicated Host port (top one is USB-OTG)

=== Expansion Ports ===
All GPIO pins, including UART, operate at 3.3V. (See VCCIO5 in the schematics.)

* 2x20 pins "Pi2" GPIO Header
* 2x11 pins "Pi P5+" GPIO Header (with 2nd 10/100Mbps Ethernet pins)

== ROCK64 Board Information, Schematics and Certifications ==
* Board Dimensions: 85mm x 56mm x 18.8mm
** [https://files.pine64.org/doc/rock64/rock64%20board%20dimension.pdf ROCK64 board dimension drawing]
* Input Power: +5V @3A with 3.5mm/1.35mm Type H Barrel type DC connector (@2A will work if there is no heavy load on the USB 3.0 port)
* ROCK64 ver 3.0 SBC related info
** [https://files.pine64.org/doc/rock64/Rock64%20Ver%203%20change%20notice.pdf ROCK64 SBC v3.0 Change Notice]
** [https://files.pine64.org/doc/rock64/ROCK64_Schematic_v3.0_20181105.pdf ROCK64 Schematic v3.0 (Production Release)]
** [https://files.pine64.org/doc/rock64/ROCK64_comp_ref_top_v3.0_20181105.pdf ROCK64 Component Reference location v3.0 (top layer)]
** [https://files.pine64.org/doc/rock64/ROCK64_comp_ref_bottom_v3.0_20181105.pdf ROCK64 Component Reference location v3.0 (bottom layer)]
** [https://files.pine64.org/doc/rock64/ROCK64_V3_Pi-2_and_Pi-P5+_Bus.pdf ROCK64 SBC v3.0 Pi-2 and Pi-P5+ Bus GPIO Assignment]
* [https://files.pine64.org/doc/rock64/R64V3%20RTC%20Batt%20connector.png ROCK64 Rev3 SBC RTC Battery Connector polarity]
* ROCK64 ver 2.0 SBC related info
** [https://files.pine64.org/doc/rock64/ROCK64_Schematic_v2.0_20171019.pdf ROCK64 Schematic v2.0 (Production Release)]
** [https://files.pine64.org/doc/rock64/ROCK64_Pi-2%20_and_Pi_P5+_Bus.pdf ROCK64 SBC v2.0 Pi-2 and Pi-P5+ Bus GPIO Assignment]
* [https://github.com/Leapo/Rock64-R64.GPIO Github on ROCK64 GPIO library, thanks to Leapo]
* [http://synfare.com/599N105E/hwdocs/rock64/index.html Good documentation about ROCK64 GPIO pins article]
* [https://files.pine64.org/doc/rock64/ROCK64_ES9023_Audio_100Mbps_Ethernet_Board.pdf ROCK64 Audio DAC with 10/100Mbps Ethernet POT Board Schematic]
* ROCK64 3-D autodesk drawing, thanks and courtesy of TeaPack
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e818b9e1b31b54545?viewState=NoIgbgDAdAjCA0IAsSDMAzAnAQwCaoFoYBjAdhgICNTVcCA2S9AJgIFMJTsAOGTU3LmLYQAXSA ROCK64 board 2D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e6078b748ecd478e1?viewState=NoIgbgDAdAjCA0IDeAdEAXAngBwKZoC40ARXAZwEsBzAOzXjQEMyzd1C0AmAEwGYZOAI0G4AtAA4ArABZeo6eIiNRggJwxuomAHYAxoOm6YMaQDZOvNAF8QAXSA ROCK64 board 3D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e45a87155aecc813f?viewState=NoIgbgDAdAjCA0IDeAdEAXAngBwKZoC40ARXAZwEsBzAOzXjQEMyzd1C0BWAYwgGYYAEyEBaQQDYARoJEAWfjMmzckkQCYAHCs5LZAMxi41aAL4gAukA ROCK64 Audio DAC with 10/100Mbps Ethernet POT board 3D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761ee09b497ae3f2f72e?viewState=NoIgbgDAdAjCA0IBmSYEMAcBmAbBgtACwBGhMRATMeQKYYYX5ICcAJhjYWjDBGgKwgAukA ROCK64 board with Audio DAC POT board 3D drawing @courtesy of TeaPack]
* ROCK64 Certifications:
** Disclaimer: Please note that PINE64 SBC is not a "final" product and in general certification is not necessary. However, PINE64 still submits the SBC for FCC, CE, and ROHS certifications and obtain the certificates to prove that the SBC board can pass the testing. Please note, a final commercial product needs to perform its own testing and obtain its own certificate.
** [https://files.pine64.org/doc/cert/ROCK64%20FCC%20certification%20VOC20171129.pdf ROCK64 FCC Certificate]
** [https://files.pine64.org/doc/cert/ROCK64%20CE%20certification%20VOC20171129.pdf ROCK64 CE Certificate]
** [https://files.pine64.org/doc/cert/ROCK64%20ROHS%20certification%20VOC20170927.pdf ROCK64 RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3328 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2017/0118/829.html Rockchip RK3328 SoC Brief]
** [https://rockchip.fr/RK3328%20datasheet%20V1.2.pdf Rockchip RK3328 Datasheet V1.2]
** [https://opensource.rock-chips.com/images/9/97/Rockchip_RK3328TRM_V1.1-Part1-20170321.pdf Rockchip RK3328 Technical Reference Manual part 1]
** [https://files.pine64.org/doc/rock64/Rockchip_RK805_Datasheet_V1.1%C2%A020160921.pdf Rockchip RK805 Datasheet V1.1]
* LPDDR3 (178 Balls) SDRAM:
** [https://files.pine64.org/doc/rock64/H9CCNNNCLTMLAR(Rev1.2).pdf Hynix LPDDR3 Datasheet V1.2]
** [https://files.pine64.org/doc/rock64/K4E8E324EB-EGCF000_DRAM_178F_11x11.5_Ver.1.00.00.pdf Samsung LPDDR3 Datasheet V1.00.00]
** [https://files.pine64.org/doc/rock64/SPECTEK_178B_32GB_V91M_MOBILE_LPDDR3.pdf Spectek LPDDR3 Datasheet]
* eMMC information:
** [https://files.pine64.org/doc/rock64/PINE64_eMMC_Module_20170719.pdf PINE64 eMMC module schematic]
** [https://files.pine64.org/doc/rock64/usb%20emmc%20module%20adapter%20v2.pdf PINE64 USB adapter for eMMC module V2 schematic]
** [https://files.pine64.org/doc/rock64/USB%20adapter%20for%20eMMC%20module%20PCB.tar PINE64 USB adapter for eMMC module PCB in JPEG]
** [https://files.pine64.org/doc/datasheet/pine64/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]
* Ethernet related info:
** [https://files.pine64.org/doc/datasheet/rock64/RTL8211F-CG-Realtek.pdf Realtek RTL8211F 10/100/1000M Ethernet Transceiver Datasheet]
** [https://files.pine64.org/doc/rock64/DGKYD111B096GWA1D.pdf 10/100Mbps MegJack on Audio DAC POT board Datasheet]
* Peripheral related info:
** [https://files.pine64.org/doc/rock64/PDS-16002%20JMS578%20Datasheet%20(Rev.%201.01).pdf JMicron JMS578 to SATA Datasheet]
* Enclosure information:
** [https://files.pine64.org/doc/datasheet/case/ROCK64%20Aluminum%20Waterproof%20Die%20Cast%20Casing.pdf Outdoor Aluminum Cast Dust-proof IP67 Enclosure Drawing]
* Remote control button mapping
** [https://files.pine64.org/doc/Pine%20A64%20Schematic/remote-wit-logo.jpg Official Remote Control for the PINE A64 Button Mapping]

== Enclosures ==

[[File:Rock64-Al-Case1-1.jpg|thumb|100px]]

The ROCK64 fits in three officially sold cases.

* [["Model B" Acrylic Open Enclosure]], [https://pine64.com/product/model-b-acrylic-open-enclosure/ Store]
* [["Model B" Aluminum Waterproof Enclosure]], [https://pine64.com/product/model-b-aluminum-waterproof-enclosure/ Store]
* [[ROCK64 Premium Aluminum Casing]], [https://pine64.com/product/model-b-premium-aluminum-casing/?v=0446c16e2e66 Store]

== Troubleshooting ==

=== HDMI output disconnects as soon as it connects ===

Some older monitors seemingly can get into a weird state wherein the ROCK64 is unable to establish a proper connection with them. [[User:CounterPillow]] has seen this happen on an iiyama ProLite G2773HS connected over HDMI, and an Acer P225HQL connected over an HDMI to DVI adapter. The symptoms usually are that you see the monitor briefly turn on its backlight without displaying a picture, but then immediately either shutting off again or showing a "No Signal" message.

The solution is to completely power down your ROCK64, also removing its power source. Then plug in the monitor, and start up the ROCK64 afterwards. You should now be getting a picture again.

=== Power button doesn't do anything on a short press (Linux) ===

Make sure the <code>rk805_pwrkey</code> module is loaded, e.g. with <code>lsmod | grep rk805_pwrkey</code>. If it doesn't show up, do a <code>modprobe rk805_pwrkey</code> as root. To make this persistent, create a <code>99-rk805_pwrkey.conf</code> in <code>/etc/modules-load.d/</code> with the content <code>rk805_pwrkey</code>

If it still doesn't work, make sure your init system is actually listening to the button press. With systemd, check <code>/etc/systemd/logind.conf</code> and make sure it's either all commented out (uses defaults) or contains something like <code>HandlePowerKey=poweroff</code>. You can change the short press action by setting <code>HandlePowerKey</code> to one of "ignore", "poweroff", "reboot", "halt", "kexec", "suspend", "hibernate", "hybrid-sleep", "suspend-then-hibernate", or "lock".

== Other Resources ==
* [https://forum.pine64.org/forumdisplay.php?fid=85 ROCK64 Forum]
* IRC Server: irc.pine64.org Channel: ROCK64
* [https://github.com/rock64-linux ROCK64 Linux GitHub Repo]
* [https://github.com/ayufan-rock64 ROCK64 ayufan GitHub Repo]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://github.com/JamesLinEngineer/RKMC Rockchip Android RKMC (Forked from Kodi 16.1)]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [https://wiki.pine64.org/index.php/Rock64_Guides ROCK64 Guides]
* [https://www.armbian.com/rock64 Armbian's ROCK64 Page]

[[Category:Rock64]] [[Category:Rockchip RK3328]]

ROCK64

2022-04-28T21:47:35Z

Diederik: Fix 'debian by ayufan' link and add link to official Debian Installer images

[[File:Rock64.jpg|400px|thumb|right|The ROCK64]]

The '''ROCK64''' is a credit-card size 4K60P HDR Media Board Computer powered by Rockchip RK3328 Quad-Core ARM Cortex A53 64-Bit Processor and supports up to 4GB 1866MHz LPDDR3 memory. It provides an eMMC module socket, MicroSD Card slot, Pi-2 Bus, Pi-P5+ Bus, USB 3.0, and many other peripheral interfaces for makers to integrate with sensors and other devices.

It supports many different open source operating systems, such as Android, Debian, and Yocto.

== Software releases ==
* OS build Installation Guide and tools:
** [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]
** [https://files.pine64.org/doc/rock64/tools/SD_Firmware_Tool._v1.46.zip Tools to burn Android build into a bootable microSD card]
** [https://files.pine64.org/doc/rock64/tools/AndroidTool_Release_v2.38.zip Tools that allows developer flash image into eMMC's Loader/Parameter/Misc/Kernal/Boot/Recovery/System/Backup partition]
** [https://files.pine64.org/doc/rock64/tools/DriverAssitant_v4.5.zip Windows ADB driver package]
** [[ROCK64 MAC Address]]

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

The list includes OS images and descriptions of:

* [[ROCK64_Software_Releases#Armbian|Armbian (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#AOSC|AOSC (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Manjaro ARM|Manjaro ARM (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Ubuntu 18.04 Bionic by ayufan|Ubuntu 18.04 Bionic by ayufan (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Slackware|Slackware (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#DietPi|DietPi (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#LibreELEC.28KODI.29|LibreElec for KODI (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Volumio 2 Digital Audio Player|Volumio 2 Digital Audio Player (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian|Debian Installer images (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian_by_ayufan|Debian by ayufan (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Debian_by_mrfixit2001|Debian by mrfixit2001 (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#OpenMediaVault|OpenMediaVault 64bit (microSD / eMMC boot)]]
* [[ROCK64_Software_Releases#NextCloudPi|NextCloudPi (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Recalbox|Recalbox (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#NetBSD|NetBSD (microSD / eMMC Boot)]]
* [[ROCK64_Software_Releases#Android_9.x_eMMC|Android 9.x (eMMC)]]
* [[ROCK64_Software_Releases#Android_8.x_eMMC|Android 8.x (eMMC)]] / [[ROCK64_Software_Releases#Android_8.x|Android 8.x (microSD Boot)]]
* [[ROCK64_Software_Releases#Android_7.x_eMMC|Android 7.x (eMMC)]] / [[ROCK64_Software_Releases#Android_7.x|Android 7.x (microSD Boot)]]
* [[ROCK64_Software_Releases#Android_TV_7.x_eMMC|Android TV 7.x (eMMC)]] / [[ROCK64_Software_Releases#Android_TV_7.x|Android TV 7.x (microSD Boot)]]

=== Quick Links to the Source of OS Images Build ===

Some OS images are still in '''beta or nightly build''' which are only fit for testing purposes. These should usually be avoided for normal usage, since they are '''used at your own risk'''.

* [https://github.com/ayufan-rock64/linux-build/releases/latest/ ayufan Linux]
* [https://github.com/ayufan-rock64/android-7.1/releases/latest/ ayufan Android 7.1]
* [https://github.com/Raybuntu/LibreELEC.tv/releases/latest/ Raybuntu LibreElec KODI] | [https://github.com/Kwiboo/LibreELEC.tv/releases/latest/ Kwiboo LibreElec KODI]
* [https://github.com/fire219/rock64-fedora/releases/latest/ Fire219 Fedora]
* [https://nightly.builds.lakka.tv/by_devices/RK3328.aarch64/ Lakka] | [https://github.com/rtissera/RetroPie-Setup/releases/latest/ RetroPie-Setup]
* [https://dl.armbian.com/rock64/ Armbian]
* [https://github.com/m01/rock64-arch-linux-build/releases/latest Arch Linux]
* [https://ownyourbits.com/downloads/ NextCloudPi]
* [https://dl.fail.pp.ua/slackware/images/rock64/ Slackware]

=== State of Software Support for the Hardware ===

{| class="wikitable sortable"
! Requirement
! GNU/Linux
! Android/Linux
! Kodi/Linux

|-
| 2160p 30Hz 8bit h264/h265/vp8
| partial? [https://forum.pine64.org/showthread.php?tid=4861&pid=32474#pid32474 1]
| yes
| yes

|-
| UI using GPU
| no
| yes
| yes

|-
| Youtube
| no
| yes
| no

|-
| vp9 / mpeg4 / mpeg2 / 10bit HDR / YCbCr
| no
| yes?
| yes

|}

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
|-
! scope="row" | Video Output
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchipdrm</code>
| With mpv, you'll need to specify something like <code>mpv --gpu-context=drm --drm-connector=1.HDMI-A-1</code> to get it to play back on a VT
|-
! scope="row" | 3D Acceleration
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>lima</code>
| Very recent version recommended for the best experience. Has weird glitches on HDMI output in weston.
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Broken/Not in ffmpeg
| <code>hantro_vpu</code> and <code>rockchip_vdec</code>, using <code>v4l2-requests</code>
| [https://lore.kernel.org/linux-media/49b1-608d4d00-2b-62afdf80@101971638/ Soon to be moved out of staging], ffmpeg patch set [https://patchwork.ffmpeg.org/project/ffmpeg/patch/20201209202513.27449-3-jonas@kwiboo.se/ seemingly abandoned], does not work on newer kernels. [https://github.com/Kwiboo/FFmpeg/commits/v4l2-request-hwaccel-master-stable Git branch with commits]
|-
! scope="row" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>snd_soc_rockchip_*</code>
|-
! scope="row" | Power Button
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk805_pwrkey</code>
| If your PWR switch does nothing unless held, this may need to be loaded manually with <code>modprobe</code> or by putting it in <code>/etc/modules-load.d/</code>
|-
! scope="row" | Analog Video Output
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip_drm_tve</code>
| Definitely needs some cleanup before it'd be ready for mainline, and needs some dt bindings written.
|}

== SoC and Memory Specification ==
* Based on [https://www.rock-chips.com/a/en/products/RK33_Series/2017/0118/829.html Rockchip RK3328]
[[File:Rockchip_RK3328.png|right]]

=== CPU Architecture ===
* [https://www.arm.com/products/processors/cortex-a/cortex-a53-processor.php Quad-core Cortex-A53 up to 1.5GHz CPU]
* Full implementation of the ARM architecture v8-A instruction set
* ARM Neon Advanced SIMD (single instruction, multiple data) support for accelerated media and signal processing computation
* ARMv8 Cryptography Extensions
* In-order pipeline with symmetric dual-issue of most instructions
* Unified system L2 cache
* Includes VFP v3 hardware to support single and double-precision operations
* Integrated 32KB L1 instruction cache, 32KB 4-way set associative L1 data cache
* TrustZone technology support
* Full CoreSight debug solution
* One separate power domain for CPU core system to support internal power switch, and to externally turn on/off based on different application scenario
* PD_A53: Cortex-A53 + Neon + FPU + L1 I/D Cache of core 2/3
* One isolated voltage domain to support DVFS

==== Frequencies & Voltages ====

{| class="wikitable"
! Frequency
! Voltage
|- style="text-align:right;"
| 408 MHz
| 0.950 V
|- style="text-align:right;"
| 600 MHz
| 0.950 V
|- style="text-align:right;"
| 816 MHz
| 1.000 V
|- style="text-align:right;"
| 1008 MHz
| 1.100 V
|- style="text-align:right;"
| 1200 MHz
| 1.225 V
|- style="text-align:right;"
| 1296 MHz
| 1.300 V
|}

==== Power Draw ====

These numbers for power draw have been measured through an USB power monitor (FNB38) while running the <code>stress</code> utility, whereby "cpu" stands for <code>stress --cpu 4</code> and "vm" stands for <code>stress --vm 4</code>. The former spins on the CPU, the latter stresses the memory. Real workloads are usually a mix of both. The tests were ran through ssh, with nothing besides power and ethernet plugged into the ROCK64

Please keep in mind that under real world usage, many other factors come into play. Having a display connected, running a graphical session, I/O and most importantly the connected USB peripherals can add a lot.

Helpful refresher on the formula for power (W) on DC: power = current × voltage, because the power factor is 1. The ROCK64 runs on 5V, so use that to calculate current if you need to.

{| class="wikitable"
! Frequency
! Power cpu
! Power vm
|- style="text-align:right;"
| 1296 MHz
| 2.64 W
| 2.95 W
|- style="text-align:right;"
| 1200 MHz
| 2.32 W
| 2.69 W
|- style="text-align:right;"
| 1008 MHz
| 1.90 W
| 2.31 W
|- style="text-align:right;"
| 816 MHz
| 1.62 W
| 2.05 W
|- style="text-align:right;"
| 600 MHz
| 1.45 W
| 1.85 W
|- style="text-align:right;"
| 408 MHz
| 1.33 W
| 1.72 W
|- style="text-align:right;"
| Idle (no load)
|colspan="2" style="text-align:center;"| 1.10 W
|}

It appears a good upper bound for a headless setup is in the neighbourhood of 3 W, or the energy contained in 0.025 bananas per hour.

=== GPU Architecture ===
* [https://www.arm.com/products/multimedia/mali-gpu/ultra-low-power/mali-450.php ARM Mali-450MP2 Dual-core GPU]
* OpenGL ES 1.1 and 2.0, OpenVG1.1

=== System Memory ===
* LPDDR3 RAM Memory Variants: 1GB, 2GB and 4GB.

== Board Features ==
[[File:ROCK64_sideimg.jpg|400px|thumb|right|The ROCK64 and a size comparison]]

=== Video ===
* Digital Video output up to 4K@60Hz
* 4K HDR @ 60fps
* H.264/AVC Base/Main/High/High10 profile @ level 5.1; up to 4Kx2K @ 60fps
* H.265/HEVC Main/Main10 profile @ level 5.1 High-tier; up to 4Kx2K @ 60fps
* VP9, up to 4Kx2K @ 60fps
* MPEG-1, ISO/IEC 11172-2, up to 1080P @ 60fps
* MPEG-2, ISO/IEC 13818-2, SP@ML, MP@HL, up to 1080P @ 60fps
* MPEG-4, ISO/IEC 14496-2, SP@L0-3, ASP@L0-5, up to 1080P @ 60fps
* VC-1, SP@ML, MP@HL, AP@L0-3, up to 1080P @ 60fps
* MVC is supported based on H.264 or H.265, up to 1080P @ 60fps

=== Audio ===
* 3.5mm A/V Jack (Composite Video Output and RCA Stereo support using conversion cable)

=== Network ===
* 10/100/1000Mbps Ethernet
* WiFi 802.11 b/g/n with Bluetooth 4.0 (optional USB dongle)

=== Storage ===
* microSD - bootable, supports SDHC and SDXC and storage up to 256GB
* eMMC - bootable (optional eMMC Module)
* 128Mbit (16MB) on-board SPI flash memory (empty by default) - bootable? Usually accessible as a [http://linux-mtd.infradead.org/doc/general.html Linux MTD] device at <code>/dev/mtd0</code>
* 1 USB3.0 Dedicated Host port
* 2 USB2.0 Dedicated Host port (top one is USB-OTG)

=== Expansion Ports ===
All GPIO pins, including UART, operate at 3.3V. (See VCCIO5 in the schematics.)

* 2x20 pins "Pi2" GPIO Header
* 2x11 pins "Pi P5+" GPIO Header (with 2nd 10/100Mbps Ethernet pins)

== ROCK64 Board Information, Schematics and Certifications ==
* Board Dimensions: 85mm x 56mm x 18.8mm
** [https://files.pine64.org/doc/rock64/rock64%20board%20dimension.pdf ROCK64 board dimension drawing]
* Input Power: +5V @3A with 3.5mm/1.35mm Type H Barrel type DC connector (@2A will work if there is no heavy load on the USB 3.0 port)
* ROCK64 ver 3.0 SBC related info
** [https://files.pine64.org/doc/rock64/Rock64%20Ver%203%20change%20notice.pdf ROCK64 SBC v3.0 Change Notice]
** [https://files.pine64.org/doc/rock64/ROCK64_Schematic_v3.0_20181105.pdf ROCK64 Schematic v3.0 (Production Release)]
** [https://files.pine64.org/doc/rock64/ROCK64_comp_ref_top_v3.0_20181105.pdf ROCK64 Component Reference location v3.0 (top layer)]
** [https://files.pine64.org/doc/rock64/ROCK64_comp_ref_bottom_v3.0_20181105.pdf ROCK64 Component Reference location v3.0 (bottom layer)]
** [https://files.pine64.org/doc/rock64/ROCK64_V3_Pi-2_and_Pi-P5+_Bus.pdf ROCK64 SBC v3.0 Pi-2 and Pi-P5+ Bus GPIO Assignment]
* [https://files.pine64.org/doc/rock64/R64V3%20RTC%20Batt%20connector.png ROCK64 Rev3 SBC RTC Battery Connector polarity]
* ROCK64 ver 2.0 SBC related info
** [https://files.pine64.org/doc/rock64/ROCK64_Schematic_v2.0_20171019.pdf ROCK64 Schematic v2.0 (Production Release)]
** [https://files.pine64.org/doc/rock64/ROCK64_Pi-2%20_and_Pi_P5+_Bus.pdf ROCK64 SBC v2.0 Pi-2 and Pi-P5+ Bus GPIO Assignment]
* [https://github.com/Leapo/Rock64-R64.GPIO Github on ROCK64 GPIO library, thanks to Leapo]
* [http://synfare.com/599N105E/hwdocs/rock64/index.html Good documentation about ROCK64 GPIO pins article]
* [https://files.pine64.org/doc/rock64/ROCK64_ES9023_Audio_100Mbps_Ethernet_Board.pdf ROCK64 Audio DAC with 10/100Mbps Ethernet POT Board Schematic]
* ROCK64 3-D autodesk drawing, thanks and courtesy of TeaPack
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e818b9e1b31b54545?viewState=NoIgbgDAdAjCA0IAsSDMAzAnAQwCaoFoYBjAdhgICNTVcCA2S9AJgIFMJTsAOGTU3LmLYQAXSA ROCK64 board 2D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e6078b748ecd478e1?viewState=NoIgbgDAdAjCA0IDeAdEAXAngBwKZoC40ARXAZwEsBzAOzXjQEMyzd1C0AmAEwGYZOAI0G4AtAA4ArABZeo6eIiNRggJwxuomAHYAxoOm6YMaQDZOvNAF8QAXSA ROCK64 board 3D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761e45a87155aecc813f?viewState=NoIgbgDAdAjCA0IDeAdEAXAngBwKZoC40ARXAZwEsBzAOzXjQEMyzd1C0BWAYwgGYYAEyEBaQQDYARoJEAWfjMmzckkQCYAHCs5LZAMxi41aAL4gAukA ROCK64 Audio DAC with 10/100Mbps Ethernet POT board 3D drawing @courtesy of TeaPack]
** [https://myhub.autodesk360.com/ue2b2f72e/g/shares/SH7f1edQT22b515c761ee09b497ae3f2f72e?viewState=NoIgbgDAdAjCA0IBmSYEMAcBmAbBgtACwBGhMRATMeQKYYYX5ICcAJhjYWjDBGgKwgAukA ROCK64 board with Audio DAC POT board 3D drawing @courtesy of TeaPack]
* ROCK64 Certifications:
** Disclaimer: Please note that PINE64 SBC is not a "final" product and in general certification is not necessary. However, PINE64 still submits the SBC for FCC, CE, and ROHS certifications and obtain the certificates to prove that the SBC board can pass the testing. Please note, a final commercial product needs to perform its own testing and obtain its own certificate.
** [https://files.pine64.org/doc/cert/ROCK64%20FCC%20certification%20VOC20171129.pdf ROCK64 FCC Certificate]
** [https://files.pine64.org/doc/cert/ROCK64%20CE%20certification%20VOC20171129.pdf ROCK64 CE Certificate]
** [https://files.pine64.org/doc/cert/ROCK64%20ROHS%20certification%20VOC20170927.pdf ROCK64 RoHS Certificate]

== Datasheets for Components and Peripherals ==
* Rockchip RK3328 SoC information:
** [https://www.rock-chips.com/a/en/products/RK33_Series/2017/0118/829.html Rockchip RK3328 SoC Brief]
** [https://rockchip.fr/RK3328%20datasheet%20V1.2.pdf Rockchip RK3328 Datasheet V1.2]
** [https://opensource.rock-chips.com/images/9/97/Rockchip_RK3328TRM_V1.1-Part1-20170321.pdf Rockchip RK3328 Technical Reference Manual part 1]
** [https://files.pine64.org/doc/rock64/Rockchip_RK805_Datasheet_V1.1%C2%A020160921.pdf Rockchip RK805 Datasheet V1.1]
* LPDDR3 (178 Balls) SDRAM:
** [https://files.pine64.org/doc/rock64/H9CCNNNCLTMLAR(Rev1.2).pdf Hynix LPDDR3 Datasheet V1.2]
** [https://files.pine64.org/doc/rock64/K4E8E324EB-EGCF000_DRAM_178F_11x11.5_Ver.1.00.00.pdf Samsung LPDDR3 Datasheet V1.00.00]
** [https://files.pine64.org/doc/rock64/SPECTEK_178B_32GB_V91M_MOBILE_LPDDR3.pdf Spectek LPDDR3 Datasheet]
* eMMC information:
** [https://files.pine64.org/doc/rock64/PINE64_eMMC_Module_20170719.pdf PINE64 eMMC module schematic]
** [https://files.pine64.org/doc/rock64/usb%20emmc%20module%20adapter%20v2.pdf PINE64 USB adapter for eMMC module V2 schematic]
** [https://files.pine64.org/doc/rock64/USB%20adapter%20for%20eMMC%20module%20PCB.tar PINE64 USB adapter for eMMC module PCB in JPEG]
** [https://files.pine64.org/doc/datasheet/pine64/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]
* Ethernet related info:
** [https://files.pine64.org/doc/datasheet/rock64/RTL8211F-CG-Realtek.pdf Realtek RTL8211F 10/100/1000M Ethernet Transceiver Datasheet]
** [https://files.pine64.org/doc/rock64/DGKYD111B096GWA1D.pdf 10/100Mbps MegJack on Audio DAC POT board Datasheet]
* Peripheral related info:
** [https://files.pine64.org/doc/rock64/PDS-16002%20JMS578%20Datasheet%20(Rev.%201.01).pdf JMicron JMS578 to SATA Datasheet]
* Enclosure information:
** [https://files.pine64.org/doc/datasheet/case/ROCK64%20Aluminum%20Waterproof%20Die%20Cast%20Casing.pdf Outdoor Aluminum Cast Dust-proof IP67 Enclosure Drawing]
* Remote control button mapping
** [https://files.pine64.org/doc/Pine%20A64%20Schematic/remote-wit-logo.jpg Official Remote Control for the PINE A64 Button Mapping]

== Enclosures ==

[[File:Rock64-Al-Case1-1.jpg|thumb|100px]]

The ROCK64 fits in three officially sold cases.

* [["Model B" Acrylic Open Enclosure]], [https://pine64.com/product/model-b-acrylic-open-enclosure/ Store]
* [["Model B" Aluminum Waterproof Enclosure]], [https://pine64.com/product/model-b-aluminum-waterproof-enclosure/ Store]
* [[ROCK64 Premium Aluminum Casing]], [https://pine64.com/product/model-b-premium-aluminum-casing/?v=0446c16e2e66 Store]

== Troubleshooting ==

=== HDMI output disconnects as soon as it connects ===

Some older monitors seemingly can get into a weird state wherein the ROCK64 is unable to establish a proper connection with them. [[User:CounterPillow]] has seen this happen on an iiyama ProLite G2773HS connected over HDMI, and an Acer P225HQL connected over an HDMI to DVI adapter. The symptoms usually are that you see the monitor briefly turn on its backlight without displaying a picture, but then immediately either shutting off again or showing a "No Signal" message.

The solution is to completely power down your ROCK64, also removing its power source. Then plug in the monitor, and start up the ROCK64 afterwards. You should now be getting a picture again.

=== Power button doesn't do anything on a short press (Linux) ===

Make sure the <code>rk805_pwrkey</code> module is loaded, e.g. with <code>lsmod | grep rk805_pwrkey</code>. If it doesn't show up, do a <code>modprobe rk805_pwrkey</code> as root. To make this persistent, create a <code>99-rk805_pwrkey.conf</code> in <code>/etc/modules-load.d/</code> with the content <code>rk805_pwrkey</code>

If it still doesn't work, make sure your init system is actually listening to the button press. With systemd, check <code>/etc/systemd/logind.conf</code> and make sure it's either all commented out (uses defaults) or contains something like <code>HandlePowerKey=poweroff</code>. You can change the short press action by setting <code>HandlePowerKey</code> to one of "ignore", "poweroff", "reboot", "halt", "kexec", "suspend", "hibernate", "hybrid-sleep", "suspend-then-hibernate", or "lock".

== Other Resources ==
* [https://forum.pine64.org/forumdisplay.php?fid=85 ROCK64 Forum]
* IRC Server: irc.pine64.org Channel: ROCK64
* [https://github.com/rock64-linux ROCK64 Linux GitHub Repo]
* [https://github.com/ayufan-rock64 ROCK64 ayufan GitHub Repo]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [https://github.com/JamesLinEngineer/RKMC Rockchip Android RKMC (Forked from Kodi 16.1)]
* [https://opensource.rock-chips.com/ Rockchip Open Source Wiki]
* [https://wiki.pine64.org/index.php/Rock64_Guides ROCK64 Guides]
* [https://www.armbian.com/rock64 Armbian's ROCK64 Page]

[[Category:Rock64]] [[Category:Rockchip RK3328]]

ROCK64 Software Releases

2022-04-28T21:38:20Z

Diederik: spelling

This page contains a list of all available releases for the [[ROCK64]], as well as links to other resources.

= Linux Image Releases =

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

* Version 5.88 onward support Rock64-v3 board
* To find out more about Armbian and available options please visit their [https://www.armbian.com/rock64/ site]
* Armbian pack as 7zip, please unzip first before dd.
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]

=== Armbian Ubuntu Focal XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal XFCE Desktop download site]

=== Armbian Ubuntu Bionic XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Bionic XFCE DEsktop download site]
* Login with
** username: root
** password: 1234

=== Armbian Debian Buster for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Debian Buster
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Debian Buster download site]

=== Armbian Ubuntu Focal for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Ubuntu Focal
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal download site]

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

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

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

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

=== AOSC Cinnamon Community Build Image [microSD and eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/rockchip64/cinnamon/rock64/ Direct download from AOSC]

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

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

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

Manjaro editions for Rock64 are available directly from Manjaro.

[https://manjaro.org/download/#rock64 Manjaro Rock64 Download Page]

* '''Only support ROCK64 ver2 SBC'''
* To learn more about Manjaro please visit [https://forum.manjaro.org/tags/manjaroarm Manjaro Forum]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]

== Ubuntu 18.04 Bionic by ayufan ==
[[File:penguin.png|right|100px]]

* [https://github.com/ayufan-rock64/linux-build/releases ayufan ROCK64 Linux Build GitHub]
* Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* Login with
** username: rock64
** password: rock64

=== Ubuntu 18.04 Bionic LXDE Desktop (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-lxde-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 64bit (arm64) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 32bit (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic containers (DockerCE & Kubernetes) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-containers-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

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

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

=== Slackware Aarch64 XFCE Community Build Image [microSD Boot] ===
* System with a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-xfce-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

=== Slackware Aarch64 Miniroot Community Build Image [microSD Boot] ===
* System without a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-base-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

* To run the OS on eMMC
**Flash the image to micro SD, power up the board with micro SD and login
**Copy the image file to micro SD by using SFTP. The image file must be in .img. ''note : root user are not allow transfer file to micro SD.''
**After finish copy the file, power off the board and add eMMC module to the board
**Bootup the board, run below command for flashing to eMMC module
***>>dd if=[image file] of=/dev/mmcblk1 bs=10M
****''example : dd if=slack-current-aarch64-xfce_08May18-4.4.126-rock64-build-20180508.img of=/dev/mmcblk1 bs=10M''
***then edit 2 files in eMMC module:
***>> mount /dev/mmcblk1p1 /media
***>> echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt
***>> sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab
**After done, power off board and remove micro SD. Then bootup with only eMMC module.

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

== LibreELEC(KODI) ==
[[File:libreelec.jpg|right|100px]]

=== Official LibreElec KODI Build Image [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://libreelec.tv/downloads_new/rockchip/ Direct download from LibreElec site and look for PINE64 ROCK64-LibreELEC-RK3328.arm-x.x.x-rock64.img.gz]

== Volumio 2 Digital Audio Player ==
[[File:volumio.png|right|100px]]

* Volumio is a linux-based headless DAP (digital audio player), which connects to your home stereo system or your DAC
* Visit the project's website [https://community.volumio.org/t/volumio-2-on-rock64/8192 here]
* You can follow the ongoing discussion about Volumio on the [https://forum.pine64.org/showthread.php?tid=5322 PINE64 forum]

=== Volumio Digital Audio Player Community Build Image [microSD Boot] [2.528-2019-01-12] ===
* DD image (for 8GB microSD card and above)
** [https://updates.volumio.org/rock64/volumio/2.861/volumio-2.861-2020-12-22-rock64.img.zip Direct download from volumio.org]
* Login with
** Username: volumio
** Password: volumio
* '''Volumio is controlled using a Web-GUI which can be accessed via a web browser using the boards IP or volumio.local/'''

== Lakka ==
[[File:lakka.png|right|100px]]

=== Lakka Community Build Image [microSD / eMMC Boot] ===
* [https://www.lakka.tv/ Lakka] The open source game console; a lightweight Linux distribution that transforms the Rock64 into a full blown retrogaming console
* Visit [https://forum.pine64.org/showthread.php?tid=5354 PINE64 forum] for more information about the Lakka release
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://le.builds.lakka.tv/legacy-2.3/Rockchip.ROCK64.arm/ Direct download from Lakka]
* [[Lakka|Lakka Basic Setup]]

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

=== Debian Installer - Bullseye ===
* Go to Debian Bullseye's [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-bullseye-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and connect a serial console and boot up to start the Debian Installer

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

=== Debian Installer - Daily Build (for Bookworm+) ===
* Go to Debian's daily build [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-daily-build-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and boot up to start the Debian Installer. It should work with both a [bugs.debian.org/1009014 normal display as a serial console]

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

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

=== Debian Stretch Minimal 64bit (arm64) OS Image [microSD / eMMC Boot] [0.8.3] ===
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-minimal-rock64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 212MB
* Login with
** username: rock64
** password: rock64
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309&pid=39314#pid39314 here]

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

=== Minimal Debian [microSD / eMMC Boot] ===
** DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/mrfixit2001/debian_builds/releases Direct download from mrfixit2001's github]
** Version 190514 onward support Rock64-v3 board
* Login with
** username: rock
** password: rock

== OpenMediaVault ==
[[File:omv.png|right|100px]]

=== Jessie OpenMediaVault Community Build Image [microSD to eMMC] [0.5.15-136] by ayufan ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page]
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
'''* There's a bug with eMMC in the "Stable" version of openmediavault linked from the wiki page. In order to use eMMC, please you need to be on the latest (pre-release) version which is linked here https://github.com/ayufan-rock64/linux-build/releases'''
*
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github]
* [https://files.pine64.org/os/ROCK64/omv/jessie-openmediavault-rock64-0.5.15-136-armhf_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7E423EF9146EA15403E7D1B4EA30594A
** File Size: 487MB
** Credentials (console/ssh, except OMV): rock64/rock64
** Credentials (OMV for Web): admin/openmediavault
** Credentials (OMV for console): root/openmediavault
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

=== Stretch OpenMediaVault OS Image 32bit (armhf) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rock64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
** size: 391MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

=== Stretch OpenMediaVault OS Image 64bit (arm64) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 340MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

== NextCloudPi==
[[File:nextcloudpi.png|right|100px]]

=== NextCloudPi Community Build Image [microSD / eMMC Boot] [03-10-19] ===
* NextCloudPi comes not only with NextCloud preinstalled, but also with management tools for backups, SSL certificates, SAMBA, enhanced security and more.
* Visit the project's [https://nextcloudpi.com website]
* You can follow the ongoing discussion about NextCloudPi on the [https://forum.pine64.org/showthread.php?tid=6047 PINE64 forum]
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://files.pine64.org/os/ROCK64/nextcloudplus/NextCloudPi_Rock64_03-10-19.img.xz Direct download from pine64.org]
*** MD5 (XZ file): 1432c8b8082696f38770004b3cb5ac1e
*** File Size: 310MB
* Login with
** username: root
** password: 1234

== Recalbox ==
[[File:RB.png|right|100px]]

=== Recalbox Community Build Image [microSD / eMMC boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Recalbox allows you to re-play a variety of videogame consoles and platforms in your living room, with ease!
* To find out more about Recalbox and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7111 PINE64 forum thread]
*Visit the project's [https://www.recalbox.com/ website]
* DD image (for 8GB microSD card and above)
** [https://github.com/mrfixit2001/recalbox_rock64/releases Direct download latest release build from mrfixit2001 github]

== Cent OS [No Longer Maintained] ==
[[File:Centos.png|right|100px]]

=== CentOS-7 Community Build Image [microSD Boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Centos-7.4.1708 with kernel from Armbian-5.69 (minimum build)
** DD image (for 8GB microSD card and above)
** [https://github.com/Project31/centos-pine64/releases/download/v7.4.1708-v5.59/centos7-rock64.img.xz Project31 download mirrors]
* To find out more on installation process, please visit their [https://project31.github.io/pine64/ Project31 site]
* Login with
** username: root
** password: centos

== NEMS Linux ==
[[File:nems.jpg|right|100px]]

https://files.pine64.org/sw/pine64_installer/json/nems.jpg
* '''Only support ROCK64 ver2 SBC'''
* NEMS stands for "Nagios Enterprise Monitoring Server" and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers.
* To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread]
* Login with
** Username: nemsadmin
** Password: nemsadmin
* [https://docs.nemslinux.com/installation Installation Guide]
* To find out more on NEM Linux, please visit their [https://nemslinux.com/ site]

=== NEMS Linux [microSD / eMMC boot] [v1.5 - build 2] ===
* DD image (for 16GB microSD card and above)
** [https://nemslinux.com/download/nagios-for-pine64.php Download torrent seed from NEMS Linux]
** [https://files.pine64.org/os/ROCK64/nems/NEMS_v1.5-Rock64-Build2.zip Direct download from pine64.org]
*** MD5 (XZ file): 6e2088922c5d197db8b8ba3057120389
*** File Size: 1.30GB

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

=== Fedora Minimal Community Build Image [microSD boot] [Preliminary Build] ===
* [https://github.com/fire219/rock64-fedora/releases/ Follow up on Fire219 github]

= BSD Image Releases =

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

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

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

* You can install OpenBSD on your Rock64 by following [https://github.com/krjdev/rock64_openbsd these instructions]
 

==FreeBSD==
<div style=float:right>[[File:Freebsd_Logo.png|right|100px]]</div>
The [https://wiki.freebsd.org/arm/RockChip#Rock64 RockChip FreeBSD page] has instructions for installing FreeBSD.

* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]
* Version 13.0 and greater include prebuilt images. Find the link in the SD Card Images section and download the ROCK64 image.
* SSH is enable by default and can be accessed with the following account:
:: username: freebsd
:: password: freebsd
* The root account credentials are:
:: username: root
:: password: root

= Android Image Releases =

== Android TV 9.x eMMC (No Google Play) ==
[[File:android_9.png|right|100px]]

'''* For install Playstore on Android 9.0, please follows [https://forum.pine64.org/showthread.php?tid=8655 this forum thread]'''

=== Android 9.0 Stock Image [eMMC Boot] using DD method [20190617] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D985808B4CA912201372DC2F5F322AE9
*** File Size: 560MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5D65A44F78BD08B4584413C8BEEAAF05
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): B34D1C119386CBA1658E5F0FB9E4413D
*** File Size: 615MB

=== Android 9.0 Stock Image [eMMC Boot] using ROCKChip tools method [20190617] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Android TV build version
** [https://files.pine64.org/os/ROCK64/android/ROCK64_20190617_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 9B717263E7749A732C8B5C7D7D59C5C6
*** File Size: 544MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using DD method [20190618] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): DBB5B3D46B77A33BC9F09173C9788E6E
*** File Size: 561MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5F3B97EA72B3227082500B3FB1FAB44A
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 6833B124ABA3AC2269A6B4F51EFD1109
*** File Size: 615MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using ROCKChip tools method [20190618] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190618_stock_rooted_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): FC5F80C3A939AD0F8DCE5B85F22D20A1
** File Size: 544MB

== Android 9.x (No Google Play) ==
[[File:android_9.png|right|100px]]

=== Android 9.0 Stock Rooted Image [microSD Boot] using DD method [20190621] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* DD image for 8GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): A250B72CD6AAB24B8156DE08EB15530C
*** File Size: 546MB
* DD image for 16GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09A6BACD71159853D5E4C6C21C883B0F
*** File Size: 556MB
* DD image for 32GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): C68DC5D96F1C546B96EC690CE7BFE910
*** File Size: 574MB
* DD image for 64GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4EFC87B4CEE4C7655618DCA95EF7DD0D
*** File Size: 707MB

=== Android 9.0 Stock Rooted Image [microSD Boot] using ROCKChip SDDisk tools method [20190621] ===
* Please unzip first and then using Android tool to flash in
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://files.pine64.org/os/ROCK64/android/SDDiskTool_v1.57.zip Rockchip SDDisk Tool ver 1.57]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190621_stock_rooted_android_9.0_sdboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): EE00D309745F842213E21B2F1E20C510
** File Size: 539MB

== Android 8.x TV eMMC (preinstalled Google Play Store) ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [eMMC Boot] using DD method [20180606] ===
* DD image to eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180606_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): C05846B89A6483DA911CEA604627524F
** File Size: 561MB

=== Android 8.1. Stock Image [eMMC Boot] using ROCKChip tools method [20180606] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/rock64_android8.1_emmc_boot_v1.1.zip Direct download from pine64.org]
** MD5 (XZ file): 9738F060D2F62A83637797363D2B38C9
** File Size: 752MB

== Android 8.x TV ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [microSD Boot] [20180623] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180623_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 85372A568C114ADE7CD9632CEBA193E9
** File Size: 575MB

== Android 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android 7.1.2 Stock Image [microSD to eMMC] [Rooted] [20171204] ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper, then it will start writing the new image to the eMMC. Please allow around 1 minute of boot up time before UI is presented via HDMI
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 43443467DFCAEDE767556843EB4D6707
** File Size: 558MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android 7.1.2 Stock Image [eMMC Boot] [Rooted] [20171204] ===
* Please unzip first and then using Android tool to flash in
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7C831F9E6B4311A3B3D4743FBBB628D0
** File Size: 544MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

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

=== Android 7.1.2 Stock Image [microSD Boot] [Rooted] [20171204] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 56520ED3DB6E587DA140AD314A055EB2
** File Size: 544MB

== Android TV 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD to eMMC] [v0.3.4-r86] by ayufan ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
* [https://github.com/ayufan-rock64/android-7.1/releases/tag/0.3.4 Release notes on ayufan Android 7.1 github]
* Please allow 5 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/android-7.1-rock-64-rock64_atv-v0.3.4-r86-raw_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 6FD1FA4BE87EC2D4E0862F66541BC6F0
** File Size: 716MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android TV 7.1 Community Build Image [eMMC] by ayufan ===
* For eMMC flash-all image, please unzip first and then use Android tool to flash in
** [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-update.zip]
* See [[ROCK64 MAC Address]] on how to set the MAC address.

== Android TV 7.x ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD Boot] by ayufan ===
* [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-raw.img.gz]

= Android SDK =

=== Android P SDK [v9.0] ===
* [https://files.pine64.org//SDK/ROCK64/ROCK64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 1EAC08942E238293E3AF11C7890DF307
** File Size: 104.34GB

[[Category:Rock64]]

ROCK64 Software Releases

2022-04-28T21:36:51Z

Diederik: Add info and links to the official Debian Installer images

This page contains a list of all available releases for the [[ROCK64]], as well as links to other resources.

= Linux Image Releases =

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

* Version 5.88 onward support Rock64-v3 board
* To find out more about Armbian and available options please visit their [https://www.armbian.com/rock64/ site]
* Armbian pack as 7zip, please unzip first before dd.
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]

=== Armbian Ubuntu Focal XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal XFCE Desktop download site]

=== Armbian Ubuntu Bionic XFCE Desktop [microSD / eMMC Boot] ===
* Mainline kernel build
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Bionic XFCE DEsktop download site]
* Login with
** username: root
** password: 1234

=== Armbian Debian Buster for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Debian Buster
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Debian Buster download site]

=== Armbian Ubuntu Focal for Server and Light Desktop [microSD / eMMC Boot] ===
* Armbian provides a mainline kernel build images for Ubuntu Focal
* DD image (for 8GB microSD card or eMMC Module and above)
** [https://armbian.tnahosting.net/archive/rock64/archive/ Armbian's ROCK64 Ubuntu Focal download site]

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

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

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

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

=== AOSC Cinnamon Community Build Image [microSD and eMMC Boot] ===
* [https://releases.aosc.io/os-arm64/rockchip64/cinnamon/rock64/ Direct download from AOSC]

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

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

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

Manjaro editions for Rock64 are available directly from Manjaro.

[https://manjaro.org/download/#rock64 Manjaro Rock64 Download Page]

* '''Only support ROCK64 ver2 SBC'''
* To learn more about Manjaro please visit [https://forum.manjaro.org/tags/manjaroarm Manjaro Forum]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]

== Ubuntu 18.04 Bionic by ayufan ==
[[File:penguin.png|right|100px]]

* [https://github.com/ayufan-rock64/linux-build/releases ayufan ROCK64 Linux Build GitHub]
* Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* Login with
** username: rock64
** password: rock64

=== Ubuntu 18.04 Bionic LXDE Desktop (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-lxde-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 64bit (arm64) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic minimal 32bit (armhf) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-minimal-rock64-0.9.14-1159-armhf.img.xz Direct download from ayufan's github]

=== Ubuntu 18.04 Bionic containers (DockerCE & Kubernetes) Image [microSD / eMMC Boot] [0.9.14] ===
* [https://github.com/ayufan-rock64/linux-build/releases/download/0.9.14/bionic-containers-rock64-0.9.14-1159-arm64.img.xz Direct download from ayufan's github]

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

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

=== Slackware Aarch64 XFCE Community Build Image [microSD Boot] ===
* System with a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-xfce-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

=== Slackware Aarch64 Miniroot Community Build Image [microSD Boot] ===
* System without a graphical shell
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [http://dl.fail.pp.ua/slackware/images/rock64/ Direct download from http://dl.fail.pp.ua and look for slarm64-current-aarch64-base-rock64-x.xx.x-build-xxxxxxxx.img.zst]
* Login with
** Username : root
** Password : password

* To run the OS on eMMC
**Flash the image to micro SD, power up the board with micro SD and login
**Copy the image file to micro SD by using SFTP. The image file must be in .img. ''note : root user are not allow transfer file to micro SD.''
**After finish copy the file, power off the board and add eMMC module to the board
**Bootup the board, run below command for flashing to eMMC module
***>>dd if=[image file] of=/dev/mmcblk1 bs=10M
****''example : dd if=slack-current-aarch64-xfce_08May18-4.4.126-rock64-build-20180508.img of=/dev/mmcblk1 bs=10M''
***then edit 2 files in eMMC module:
***>> mount /dev/mmcblk1p1 /media
***>> echo "rootdev=/dev/mmcblk1p1" >> /media/boot/uEnv.txt
***>> sed -i 's:mmcblk0p1:mmcblk1p1:' /media/etc/fstab
**After done, power off board and remove micro SD. Then bootup with only eMMC module.

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

== LibreELEC(KODI) ==
[[File:libreelec.jpg|right|100px]]

=== Official LibreElec KODI Build Image [microSD / eMMC boot] ===

* Unzip and DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
* 8GB microSD card or eMMC module and above
** [https://libreelec.tv/downloads_new/rockchip/ Direct download from LibreElec site and look for PINE64 ROCK64-LibreELEC-RK3328.arm-x.x.x-rock64.img.gz]

== Volumio 2 Digital Audio Player ==
[[File:volumio.png|right|100px]]

* Volumio is a linux-based headless DAP (digital audio player), which connects to your home stereo system or your DAC
* Visit the project's website [https://community.volumio.org/t/volumio-2-on-rock64/8192 here]
* You can follow the ongoing discussion about Volumio on the [https://forum.pine64.org/showthread.php?tid=5322 PINE64 forum]

=== Volumio Digital Audio Player Community Build Image [microSD Boot] [2.528-2019-01-12] ===
* DD image (for 8GB microSD card and above)
** [https://updates.volumio.org/rock64/volumio/2.861/volumio-2.861-2020-12-22-rock64.img.zip Direct download from volumio.org]
* Login with
** Username: volumio
** Password: volumio
* '''Volumio is controlled using a Web-GUI which can be accessed via a web browser using the boards IP or volumio.local/'''

== Lakka ==
[[File:lakka.png|right|100px]]

=== Lakka Community Build Image [microSD / eMMC Boot] ===
* [https://www.lakka.tv/ Lakka] The open source game console; a lightweight Linux distribution that transforms the Rock64 into a full blown retrogaming console
* Visit [https://forum.pine64.org/showthread.php?tid=5354 PINE64 forum] for more information about the Lakka release
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://le.builds.lakka.tv/legacy-2.3/Rockchip.ROCK64.arm/ Direct download from Lakka]
* [[Lakka|Lakka Basic Setup]]

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

=== Debian Installer - Bullseye ===
* Go to Debian Bullseye's [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-bullseye-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and connect a serial console and boot up to start the Debian Installer

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://deb.debian.org/debian/dists/bullseye/main/installer-arm64/current/images/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

=== Debian Installer - Daily Build (for Bookworm+) ===
* Go to Debian daily build [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/ official d-i concatenateable images] directory
* Download firmware.rock64-rk3328.img.gz and partition.img.gz
* Combine the 2 parts into 1 image file: <code>zcat firmware.rock64-rk3328.img.gz partition.img.gz > debian-installer-daily-build-rock64-rk3328.img</code>*
* Write the created .img file to microSD card or eMMC Module with <code>dd</code>
* Plug the microSD/eMMC card in the Rock64 and boot up to start the Debian Installer. It should work with both a [bugs.debian.org/1009014 normal display as a serial console]

<nowiki>*</nowiki>) (for non-Linux systems, consult [https://d-i.debian.org/daily-images/arm64/daily/netboot/SD-card-images/README.concatenateable_images README.concatenateable_images])

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

=== Debian Stretch Minimal 64bit (arm64) OS Image [microSD / eMMC Boot] [0.8.3] ===
* DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-minimal-rock64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 212MB
* Login with
** username: rock64
** password: rock64
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309&pid=39314#pid39314 here]

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

=== Minimal Debian [microSD / eMMC Boot] ===
** DD image to microSD card or eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://github.com/mrfixit2001/debian_builds/releases Direct download from mrfixit2001's github]
** Version 190514 onward support Rock64-v3 board
* Login with
** username: rock
** password: rock

== OpenMediaVault ==
[[File:omv.png|right|100px]]

=== Jessie OpenMediaVault Community Build Image [microSD to eMMC] [0.5.15-136] by ayufan ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page]
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
'''* There's a bug with eMMC in the "Stable" version of openmediavault linked from the wiki page. In order to use eMMC, please you need to be on the latest (pre-release) version which is linked here https://github.com/ayufan-rock64/linux-build/releases'''
*
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github]
* [https://files.pine64.org/os/ROCK64/omv/jessie-openmediavault-rock64-0.5.15-136-armhf_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7E423EF9146EA15403E7D1B4EA30594A
** File Size: 487MB
** Credentials (console/ssh, except OMV): rock64/rock64
** Credentials (OMV for Web): admin/openmediavault
** Credentials (OMV for console): root/openmediavault
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]

=== Stretch OpenMediaVault OS Image 32bit (armhf) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rock64-0.8.3-1141-armhf.img.xz Direct download from ayufan's github]
** size: 391MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

=== Stretch OpenMediaVault OS Image 64bit (arm64) [microSD / eMMC Boot] [0.8.3] ===
* [https://www.openmediavault.org/ openmediavault is the next generation network attached storage (NAS) solution, click link to OMV main page to learn more]
* DD image to microSD card or eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* [https://github.com/ayufan-rock64/linux-build/releases/ Release notes on ayufan Linux github] ''(pay attention to the release tag. Don't accidentaly choose a pre-release build)''
** [https://github.com/ayufan-rock64/linux-build/releases/download/0.8.3/stretch-openmediavault-rockpro64-0.8.3-1141-arm64.img.xz Direct download from ayufan's github]
** size: 340MB
* WebGUI Login:
** username: admin
** password: openmediavault
* SSH/ Console Login:
** username: root
** password: openmediavault
*** '''NB! You need to enable root login in OMV WebGUI'''
* [[OpenMediaVault|OpenMediaVault Basic Setup]]
* [https://omv-extras.org/joomla/index.php/omv-plugins-3/3-stable OpenMediaVault Plugins]
*Forum thread concerning this release can be found [https://forum.pine64.org/showthread.php?tid=6309 here]

== NextCloudPi==
[[File:nextcloudpi.png|right|100px]]

=== NextCloudPi Community Build Image [microSD / eMMC Boot] [03-10-19] ===
* NextCloudPi comes not only with NextCloud preinstalled, but also with management tools for backups, SSL certificates, SAMBA, enhanced security and more.
* Visit the project's [https://nextcloudpi.com website]
* You can follow the ongoing discussion about NextCloudPi on the [https://forum.pine64.org/showthread.php?tid=6047 PINE64 forum]
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
** [https://files.pine64.org/os/ROCK64/nextcloudplus/NextCloudPi_Rock64_03-10-19.img.xz Direct download from pine64.org]
*** MD5 (XZ file): 1432c8b8082696f38770004b3cb5ac1e
*** File Size: 310MB
* Login with
** username: root
** password: 1234

== Recalbox ==
[[File:RB.png|right|100px]]

=== Recalbox Community Build Image [microSD / eMMC boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Recalbox allows you to re-play a variety of videogame consoles and platforms in your living room, with ease!
* To find out more about Recalbox and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7111 PINE64 forum thread]
*Visit the project's [https://www.recalbox.com/ website]
* DD image (for 8GB microSD card and above)
** [https://github.com/mrfixit2001/recalbox_rock64/releases Direct download latest release build from mrfixit2001 github]

== Cent OS [No Longer Maintained] ==
[[File:Centos.png|right|100px]]

=== CentOS-7 Community Build Image [microSD Boot] ===
* '''Only support ROCK64 ver2 SBC'''
* Centos-7.4.1708 with kernel from Armbian-5.69 (minimum build)
** DD image (for 8GB microSD card and above)
** [https://github.com/Project31/centos-pine64/releases/download/v7.4.1708-v5.59/centos7-rock64.img.xz Project31 download mirrors]
* To find out more on installation process, please visit their [https://project31.github.io/pine64/ Project31 site]
* Login with
** username: root
** password: centos

== NEMS Linux ==
[[File:nems.jpg|right|100px]]

https://files.pine64.org/sw/pine64_installer/json/nems.jpg
* '''Only support ROCK64 ver2 SBC'''
* NEMS stands for "Nagios Enterprise Monitoring Server" and it is a modern pre-configured, customized and ready-to-deploy Nagios Core image designed to run on low-cost micro computers.
* To find out more about NEMS on the PINE64 and available tweaks to the installation please visit the [https://forum.pine64.org/showthread.php?tid=7306 PINE64 forum thread]
* Login with
** Username: nemsadmin
** Password: nemsadmin
* [https://docs.nemslinux.com/installation Installation Guide]
* To find out more on NEM Linux, please visit their [https://nemslinux.com/ site]

=== NEMS Linux [microSD / eMMC boot] [v1.5 - build 2] ===
* DD image (for 16GB microSD card and above)
** [https://nemslinux.com/download/nagios-for-pine64.php Download torrent seed from NEMS Linux]
** [https://files.pine64.org/os/ROCK64/nems/NEMS_v1.5-Rock64-Build2.zip Direct download from pine64.org]
*** MD5 (XZ file): 6e2088922c5d197db8b8ba3057120389
*** File Size: 1.30GB

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

=== Fedora Minimal Community Build Image [microSD boot] [Preliminary Build] ===
* [https://github.com/fire219/rock64-fedora/releases/ Follow up on Fire219 github]

= BSD Image Releases =

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

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

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

* You can install OpenBSD on your Rock64 by following [https://github.com/krjdev/rock64_openbsd these instructions]
 

==FreeBSD==
<div style=float:right>[[File:Freebsd_Logo.png|right|100px]]</div>
The [https://wiki.freebsd.org/arm/RockChip#Rock64 RockChip FreeBSD page] has instructions for installing FreeBSD.

* Images for various FreeBSD releases can be found [https://www.freebsd.org/where/ here]
* Version 13.0 and greater include prebuilt images. Find the link in the SD Card Images section and download the ROCK64 image.
* SSH is enable by default and can be accessed with the following account:
:: username: freebsd
:: password: freebsd
* The root account credentials are:
:: username: root
:: password: root

= Android Image Releases =

== Android TV 9.x eMMC (No Google Play) ==
[[File:android_9.png|right|100px]]

'''* For install Playstore on Android 9.0, please follows [https://forum.pine64.org/showthread.php?tid=8655 this forum thread]'''

=== Android 9.0 Stock Image [eMMC Boot] using DD method [20190617] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): D985808B4CA912201372DC2F5F322AE9
*** File Size: 560MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5D65A44F78BD08B4584413C8BEEAAF05
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190617_stock_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): B34D1C119386CBA1658E5F0FB9E4413D
*** File Size: 615MB

=== Android 9.0 Stock Image [eMMC Boot] using ROCKChip tools method [20190617] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Android TV build version
** [https://files.pine64.org/os/ROCK64/android/ROCK64_20190617_stock_android_9.0_emmcboot.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 9B717263E7749A732C8B5C7D7D59C5C6
*** File Size: 544MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using DD method [20190618] ===
* DD image to eMMC module using USB adapter for eMMC module and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* DD image for 16GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): DBB5B3D46B77A33BC9F09173C9788E6E
*** File Size: 561MB
* DD image for 32GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 5F3B97EA72B3227082500B3FB1FAB44A
*** File Size: 579MB
* DD image for 64GB eMMC module
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190618_stock_rooted_android_9.0_emmcboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 6833B124ABA3AC2269A6B4F51EFD1109
*** File Size: 615MB

=== Android 9.0 Stock Rooted Image [eMMC Boot] using ROCKChip tools method [20190618] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port, needs USB type A to type A cable.
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190618_stock_rooted_android_9.0_emmcboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): FC5F80C3A939AD0F8DCE5B85F22D20A1
** File Size: 544MB

== Android 9.x (No Google Play) ==
[[File:android_9.png|right|100px]]

=== Android 9.0 Stock Rooted Image [microSD Boot] using DD method [20190621] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher] or [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md#download PINE64 Installer]
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* DD image for 8GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-8GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): A250B72CD6AAB24B8156DE08EB15530C
*** File Size: 546MB
* DD image for 16GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-16GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 09A6BACD71159853D5E4C6C21C883B0F
*** File Size: 556MB
* DD image for 32GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-32GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): C68DC5D96F1C546B96EC690CE7BFE910
*** File Size: 574MB
* DD image for 64GB microSD card
** [https://files.pine64.org/os/ROCK64/android/ROCK64_dd_20190621_stock_rooted_android_9.0_sdboot-64GB.img.gz Direct download from pine64.org]
*** MD5 (GZip file): 4EFC87B4CEE4C7655618DCA95EF7DD0D
*** File Size: 707MB

=== Android 9.0 Stock Rooted Image [microSD Boot] using ROCKChip SDDisk tools method [20190621] ===
* Please unzip first and then using Android tool to flash in
* Please allow 3-5 minutes boot up time on first time for initialization
* This is Rooted Android TV build version
* [https://files.pine64.org/os/ROCK64/android/SDDiskTool_v1.57.zip Rockchip SDDisk Tool ver 1.57]
* [https://files.pine64.org/os/ROCK64/android/ROCK64_20190621_stock_rooted_android_9.0_sdboot.img.gz Direct download from pine64.org]
** MD5 (GZip file): EE00D309745F842213E21B2F1E20C510
** File Size: 539MB

== Android 8.x TV eMMC (preinstalled Google Play Store) ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [eMMC Boot] using DD method [20180606] ===
* DD image to eMMC module. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180606_stock_android_8.1_emmcboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): C05846B89A6483DA911CEA604627524F
** File Size: 561MB

=== Android 8.1. Stock Image [eMMC Boot] using ROCKChip tools method [20180606] ===
* Please unzip first and then using Android tool to flash in
* The OTG port located at top USB 2.0 port
* [https://wiki.pine64.org/index.php/NOOB#Flashing_to_eMMC_using_Rockchip_Tools_.28Rock64_Only.29 Guide to flashing eMMC using Rockchip Tools]
* [https://files.pine64.org/os/ROCK64/android/rock64_android8.1_emmc_boot_v1.1.zip Direct download from pine64.org]
** MD5 (XZ file): 9738F060D2F62A83637797363D2B38C9
** File Size: 752MB

== Android 8.x TV ==
[[File:android_8.png|right|100px]]

=== Android 8.1. Stock Image [microSD Boot] [20180623] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/rock64_20180623_stock_android_8.1_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 85372A568C114ADE7CD9632CEBA193E9
** File Size: 575MB

== Android 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android 7.1.2 Stock Image [microSD to eMMC] [Rooted] [20171204] ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper, then it will start writing the new image to the eMMC. Please allow around 1 minute of boot up time before UI is presented via HDMI
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 43443467DFCAEDE767556843EB4D6707
** File Size: 558MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android 7.1.2 Stock Image [eMMC Boot] [Rooted] [20171204] ===
* Please unzip first and then using Android tool to flash in
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 7C831F9E6B4311A3B3D4743FBBB628D0
** File Size: 544MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

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

=== Android 7.1.2 Stock Image [microSD Boot] [Rooted] [20171204] ===
* DD image to microSD card and boot. Highly recommend using [https://etcher.io/ Etcher]
* Please allow 10-15 minutes boot up time on first time for initialization
* USB 3.0 patches
* Enable Real Time Clock support for Popcorn Hour Transformer
* [https://files.pine64.org/os/ROCK64/android/rock64_20171204_stock_android_7.1.2_rooted_sdboot.img.xz Direct download from pine64.org]
** MD5 (XZ file): 56520ED3DB6E587DA140AD314A055EB2
** File Size: 544MB

== Android TV 7.x eMMC ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD to eMMC] [v0.3.4-r86] by ayufan ===
* DD image to microSD card. Highly recommend using [https://etcher.io/ Etcher]
** Shorting the eMMC PIN with a jumper as shown on the 1st image of [https://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf Guide to install stock Android build to eMMC module]. After power ON the box for 2-3 second, quickly remove the jumper. After boot, it will prompt for confirmation 'Y' to start writing the new image to the eMMC. Then follow the instructions on the screen
* [https://github.com/ayufan-rock64/android-7.1/releases/tag/0.3.4 Release notes on ayufan Android 7.1 github]
* Please allow 5 minutes boot up time on first time for initialization
* [https://files.pine64.org/os/ROCK64/android/android-7.1-rock-64-rock64_atv-v0.3.4-r86-raw_sd2emmc.img.xz Direct download from pine64.org]
** MD5 (XZ file): 6FD1FA4BE87EC2D4E0862F66541BC6F0
** File Size: 716MB
* See [[ROCK64 MAC Address]] on how to set the MAC address.

=== Android TV 7.1 Community Build Image [eMMC] by ayufan ===
* For eMMC flash-all image, please unzip first and then use Android tool to flash in
** [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-update.zip]
* See [[ROCK64 MAC Address]] on how to set the MAC address.

== Android TV 7.x ==
[[File:android_7.png|right|100px]]

=== Android TV 7.1 Community Build Image [microSD Boot] by ayufan ===
* [https://github.com/ayufan-rock64/android-7.1/releases/latest Direct download latest release build from ayufan github and look for android-7.1-rock-64-rock64_atv-x.x.x-xx-raw.img.gz]

= Android SDK =

=== Android P SDK [v9.0] ===
* [https://files.pine64.org//SDK/ROCK64/ROCK64_SDK_android9.0.tar.gz Direct Download from pine64.org]
** MD5 (TAR-GZip file): 1EAC08942E238293E3AF11C7890DF307
** File Size: 104.34GB

[[Category:Rock64]]

Quartz64 Development

2022-04-22T12:44:18Z

Diederik: Upstreaming Status: update VOP2 to version 11

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:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=634531]
| <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] 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:#F99; text-align:center;"|Needs porting
| <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" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code> and <code>rkvdec</code>, using <code>v4l2-requests</code>
| Necessary device tree changes for the Hantro VPU [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]. rkvdec hardware has been updated compared to rk3399 and may require driver changes.
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=630567&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" | 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
* 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 (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_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, not yet upstream
* <code>CONFIG_DRM_PANFROST</code>
** GPU
* <code>CONFIG_SND_SOC_ROCKCHIP_SPDIF</code>
** SPDIF audio
* <code>CONFIG_ROCKCHIP_DW_HDMI</code>
** HDMI PHY
* <code>CONFIG_ROCKCHIP_VOP2</code>
** Video output, not yet upstream
* <code>CONFIG_ARCH_ROCKCHIP</code>
** General SoC support
* <code>CONFIG_ROCKCHIP_PHY</code>
** General SoC support
* <code>CONFIG_PHY_ROCKCHIP_INNO_USB2</code>
** USB 2
* <code>CONFIG_RTC_DRV_RK808</code>
** Real-time Clock
* <code>CONFIG_COMMON_CLK_RK808</code>
** Real-time Clock
* <code>CONFIG_MFD_RK808</code>
** Various things relating to the RK817 chip
* <code>CONFIG_REGULATOR_RK808</code>
** Voltage regulators
* <code>CONFIG_ROCKCHIP_PM_DOMAINS</code>
** Power management domains
* <code>CONFIG_GPIO_ROCKCHIP</code>
** GPIO support
* <code>CONFIG_PINCTRL_ROCKCHIP</code>
** GPIO and general SoC support
* <code>CONFIG_PWM_ROCKCHIP</code>
** PWM support
* <code>CONFIG_ROCKCHIP_IOMMU</code>
** IOMMU support
* <code>CONFIG_ROCKCHIP_MBOX</code>
** Mailbox support (for communication with MCU)
* <code>CONFIG_ROCKCHIP_SARADC</code>
** Analog-to-digital conversion support, for e.g. microphones
* <code>CONFIG_ROCKCHIP_THERMAL</code>
** Temperature sensor and thermal throttling support
* <code>CONFIG_SPI_ROCKCHIP</code>
** SPI support
* <code>CONFIG_VIDEO_HANTRO_ROCKCHIP</code>
** Hardware video decoder support
* <code>CONFIG_ROCKCHIP_IODOMAIN</code>
** General SoC support so your I/O pins have the right voltage
* <code>CONFIG_COMMON_CLK_ROCKCHIP</code>
** Common clock support

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

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

=== Other ===

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

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

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

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

==== Bootloader Flashing ====

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

==== BSP Image Layout ====

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

Quartz64 Development

2022-03-28T19:11:03Z

Diederik: Update VOP2 patch series link to v9

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

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="2" | Video Output
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=626925]
| <code>rockchipdrm/VOP2</code>
|
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] Coordinate any porting with Rockchip first
|-
! scope="row" | 3D Acceleration
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=612521]
| style="background:PaleGreen; text-align:center;"|Upstream Mesa
| <code>panfrost</code>
| GPU is basically already supported in mainline but needs some device tree changes for this particular SoC
|-
! scope="row" | Video Decode
| style="background:LightYellow; text-align:center;"|Linux Staging
| style="background:#F99; text-align:center;"|Not in ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro-vpu</code> and <code>rkvdec</code>, using <code>v4l2-requests</code>
| Necessary device tree changes for the Hantro VPU [https://patchwork.kernel.org/project/linux-rockchip/patch/20210719225806.26680-1-ezequiel@collabora.com/ in review]. rkvdec hardware has been updated compared to rk3399 and may require driver changes.
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| Quartz64 Model B
|
| Quartz64 Model B
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs submitting
| SOQuartz
|
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux 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]]

Quartz64 Installing Arch Linux ARM

2021-12-09T10:30:43Z

Diederik: Using 'unit X' is only needed when you don't specify a unit, so add a unit to the only one which hadn't and remove 'unit X'

{{note|This page is a work in progress. If you are not familiar with user-mode QEMU, wait for the 5.16 kernel release. Right now there's still an iffy step left: installing a custom kernel package to get it booting. This will no longer be necessary with Linux 5.16.}}

Commands to be run as a normal user are prefixed with <code>$</code>, commands to be run as root are prefixed with <code>#</code>. We assume your target device is <tt>/dev/sdb</tt>, adjust accordingly.

== Partitioning The Block Device ==

Here we assume your block device is <tt>/dev/sdb</tt>, adjust as needed.

Create a new partition table:

# parted -s /dev/sdb mklabel gpt

Create the partitions for loader and u-boot:

# parted -s /dev/sdb mkpart loader 64s 8MiB
# parted -s /dev/sdb mkpart uboot 8MiB 16MiB

Create the partition for u-boot's environment:

# parted -s /dev/sdb mkpart env 16MiB 32MiB

Create the "efi" boot partition and mark it as bootable:

# parted -s /dev/sdb mkpart efi fat32 32MiB 544MiB
# parted -s /dev/sdb set 4 boot on

Create the root partition:

# parted -s /dev/sdb mkpart root ext4 544MiB 100%

=== Creating The File Systems ===

Now create the file systems for boot and root:

# mkfs.vfat -n "efi" /dev/sdb4
# mkfs.ext4 -L "rootfs" /dev/sdb5

== Fetching and Flashing U-Boot ==

For this we'll use the precompiled idblock and u-boot from pgwipeout's CI.

Go to https://gitlab.com/pgwipeout/quartz64_ci/-/pipelines and click the three dots, download the merge-job artifacts.

Unzip them:

$ unzip artifacts.zip

Flash idblock.bin and uboot.img:

# dd if=artifacts/idblock.bin of=/dev/sdb1
# dd if=artifacts/uboot.img of=/dev/sdb2

== Fetching The Root File System Tarball ==

Fetch the root filesystem tarball and the PGP signature

<nowiki>$ wget -N http://os.archlinuxarm.org/os/ArchLinuxARM-aarch64-latest.tar.gz{,.sig}</nowiki>

Fetch the gpg keys:

<nowiki>$ curl 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x68b3537f39a313b3e574d06777193f152bdbe6a6' | gpg --import=-</nowiki>

Compare the key ID provided in the above command with the one listed here: https://archlinuxarm.org/about/package-signing (Take good note of the domain and HTTPS)

Verify the tarball's authenticity

$ gpg --verify ArchLinuxARM-aarch64-latest.tar.gz.sig

{{note|Do not skip verifying the authenticity. This is important. It also protects you from prematurely aborted transfers giving you a corrupt archive.}}

== Installing The Root File System ==

# mount /dev/sdb5 /mnt/alarm-root
# mkdir /mnt/alarm-root/boot
# mount /dev/sdb4 /mnt/alarm-root/boot
# bsdtar -xpf ArchLinuxARM-aarch64-latest.tar.gz -C /mnt/alarm-root

=== Editing fstab ===

Find your partition UUIDs for both partitions using <code>lsblk</code>:

$ lsblk -o NAME,SIZE,MOUNTPOINTS,PARTUUID

In <tt>/mnt/alarm-root/etc/fstab</tt>, put the lines

PARTUUID=''root-uuid-here'' / ext4 defaults 0 0
PARTUUID=''boot-uuid-here'' /boot vfat defaults 0 1

with your UUIDs in place of the placeholder.

=== Writing extlinux.conf ===

Create a <tt>/mnt/alarm-root/boot/extlinux/extlinux.conf</tt> with these contents:

default l0
menu title Quartz64 Boot Menu
prompt 0
timeout 50

label l0
menu label Boot Arch Kernel SDMMC
linux /Image
fdt /dtbs/rockchip/rk3566-quartz64-a.dtb
append initrd=/initramfs-linux.img earlycon=uart8250,mmio32,0xfe660000 console=ttyS2,1500000n8 root=/dev/mmcblk0p5 rw rootwait

For eMMC instead of SD, replace <code>/dev/mmcblk0p5</code> with <code>/dev/mmcblk1p5</code>.

For a different type of Quartz64 device (e.g. Model B) replace the <tt>fdt</tt> line with the appropriate <tt>/boot</tt>-relative path to the device tree.

=== Finishing Touches ===

{{note|Here's where you'd do the part I said was iffy and won't be necessary with 5.16 anymore. You'll need an Arch Linux or Manjaro system. If it's not an aarch64 system, you'll also need <tt>qemu-user-static</tt>.

First, get [https://overviewer.org/~pillow/up/e96363af01/linux-aarch64-rc-5.16.rc4-1-aarch64.pkg.tar.zst the linux-aarch64-rc package I patched and built], then copy it somewhere into your mounted root.

Alternatively, patch and build the package yourself by [https://github.com/archlinuxarm/PKGBUILDs/tree/master/core/linux-aarch64-rc getting the package sources] and [https://gist.github.com/CounterPillow/310273c9632f25c436fb4fdfa0128068 patching the package (in this case also for cross-compilation)].

Next, <code>arch-chroot</code> into the mounted root:

<code># arch-chroot /mnt/alarm-root</code>

and install the package

<code># pacman -U linux-aarch64-rc-5.16.rc4-1-aarch64.pkg.tar.zst</code>

Then <code>exit</code> the chroot again once it's done installing.
}}

Once done, unmount the partitions:

# umount /mnt/alarm-root/boot
# umount /mnt/alarm-root

== Booting And Finishing Setup ==

Hook up your UART dongle to your Quartz64, open a serial terminal at 1.5mbauds. Install the SD card or eMMC module inside the Quartz64, and plug in the power.

Once you hit a login shell, log in as <code>root</code> with password <code>root</code> and run:

# pacman-key --init
# pacman-key --populate archlinuxarm

You are now ready to use Arch Linux ARM! Either delete or rename (and move the homedir of) the <code>alarm</code> user, and you're all set. Don't forget to install things like <code>sudo</code> and setting up sudo groups and such.