PINE64 - User contributions [en]

Quartz64 Development

2022-06-19T15:22:22Z

Herostrat: Battery Patch is now v7 and was resend

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

== Overview ==

=== Upstreaming Status ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" | Function
! scope="col" colspan="2" | Status
! scope="col" | Component
! scope="col" | Notes
! scope="col" | Applies To
|-
! scope="row" rowspan="3" | Video Output
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchipdrm/VOP2</code>
|
As of 5.19-rc1[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=604be85547ce4d61b89292d2f9a78c721b778c16], Also featured in Phoronix Article[https://www.phoronix.com/scan.php?page=news_item&px=Rockchip-VOP2-Linux-5.19]
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/commit/d7ad116fb30d11d110aeb880754cf27f34c45c40#7e8e2ef87e479c54539dc519c0b92d6b31727f8d_671_681] Coordinate any porting with Rockchip first
|
|-
| colspan="2" style="background:#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" rowspan="3" | Video Decode
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:LightYellow; text-align:center;" rowspan="3"|GStreamer only, no ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro</code> using <code>v4l2-requests</code>
| VDPU121 handling 1080p H.263, MPEG-1, MPEG-2, VP8 and H.264. Mainline as of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=5f6bfab6da6531238e899fdf29efd6d0185adc3e]
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkvdec2</code> using <code>v4l2-requests</code>
| VDPU346 handling 4K H.265, H.264 and VP9
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkdjpeg</code> using <code>v4l2-requests</code>
| VDPU720 handling JPEG, [[User:CounterPillow]] is working on this
|-
! scope="row" rowspan="5" | [[Mainline Hardware Encoding|Video Encode]]
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=649611]
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| VP8 on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU540
| rkvenc-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.265 on VEPU540
| rkvenc-based
|
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model B
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c37415f55bdadffe5b4c0e7981e9fc7e8b96beea]. Ethernet might still be broken on production version? Need more data points.
| Quartz64 Model B
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| SOQuartz
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c466828fb3ba8cb7f5c3bf28766da9b70bf9745e]
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/patch/20220520183037.2566-2-macroalpha82@gmail.com/]
| <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]
|
|-
! scope="row" | NPU
| colspan="2" style="background:#F99; text-align:center;"|Needs writing
|
| Downstream version is a closed source SDK. Major undertaking to reimplement this as Linux does not (yet) appear to have a generic architecture for neural accelerators.
|
|-
! scope="row" | Crypto
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rk-crypto</code> v2
| Downstream driver [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/crypto/rockchip] doesn't include a rk3568 compatible either, but the TRM shows that it seemingly matches.
|
|}

== Current Status ==

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

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

=== Working ===

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

=== Partially Working ===

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

=== Confirmed Broken ===

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

=== Needs Testing ===

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

== TODO ==

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

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

=== Investigate MCU ===

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

=== Mainline U-Boot Work ===

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

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

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

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

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

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

Stretch Goals:

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

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

=== eDP Driver Porting ===

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

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

== Linux Kernel Config Options ==

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

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

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

=== Other ===

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

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

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

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

==== Bootloader Flashing ====

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

==== BSP Image Layout ====

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

Quartz64 Development

2022-06-19T15:13:29Z

Herostrat: VOP2 mainline for 5.19-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/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=604be85547ce4d61b89292d2f9a78c721b778c16], Also featured in Phoronix Article[https://www.phoronix.com/scan.php?page=news_item&px=Rockchip-VOP2-Linux-5.19]
|-
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rockchip-edpphy-naneng</code>
| Downstream: [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/blob/quartz64/drivers/phy/rockchip/phy-rockchip-naneng-edp.c] and [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/commit/d7ad116fb30d11d110aeb880754cf27f34c45c40#7e8e2ef87e479c54539dc519c0b92d6b31727f8d_671_681] Coordinate any porting with Rockchip first
|
|-
| colspan="2" style="background:#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" rowspan="3" | Video Decode
| style="background:PaleGreen; text-align:center;"|Linux Mainline
| style="background:LightYellow; text-align:center;" rowspan="3"|GStreamer only, no ffmpeg[https://patchwork.ffmpeg.org/project/ffmpeg/list/?series=2898]
| <code>hantro</code> using <code>v4l2-requests</code>
| VDPU121 handling 1080p H.263, MPEG-1, MPEG-2, VP8 and H.264. Mainline as of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=5f6bfab6da6531238e899fdf29efd6d0185adc3e]
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkvdec2</code> using <code>v4l2-requests</code>
| VDPU346 handling 4K H.265, H.264 and VP9
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| <code>rkdjpeg</code> using <code>v4l2-requests</code>
| VDPU720 handling JPEG, [[User:CounterPillow]] is working on this
|-
! scope="row" rowspan="5" | [[Mainline Hardware Encoding|Video Encode]]
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=649611]
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| VP8 on VEPU121
| Hantro-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU540
| rkvenc-based
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.265 on VEPU540
| rkvenc-based
|
|-
! scope="row" rowspan="3" | Audio
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-i2s-tdm</code>
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=43b058698f723e3c2087af7069c0da082a3ecbe1]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-spdif</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dac825b6a6bdca41347e25f07354ad94fdc97445]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk817-codec</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0d6a04da9b25b9a7cf2cac5f5079e3296d3bee0f].
| Quartz64 Model A/B
|-
! scope="row" | u-boot
| colspan="2" style="background:#F99; text-align:center;"|Waiting on ATF sources
|
|
|-
! scope="row" rowspan="4" | Device Tree
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model A
| As of 5.16[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=b33a22a1e7c4248608e533fc4fa524258b3fae84]
| Quartz64 Model A
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| Quartz64 Model B
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c37415f55bdadffe5b4c0e7981e9fc7e8b96beea]. Ethernet might still be broken on production version? Need more data points.
| Quartz64 Model B
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| SOQuartz
| As of 5.19[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c466828fb3ba8cb7f5c3bf28766da9b70bf9745e]
| SOQuartz
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| PineNote
| As of 5.18[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d449121e5e8addcee654250cec298c887ecafb32]
| PineNote
|-
! scope="row" rowspan="2"| Gigabit Ethernet
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3566-gmac</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3bb3d6b1c1957e88bfc5e77a4557f7e6ba761fe3]
|-
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>yt8511-phy</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=48e8c6f1612b3d2dccaea2285231def830cc5b8e]
|-
! scope="row" | IOMMU
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-iommu</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=c55356c534aa651ccc3053ef2d5d8d810adacf5f]
|-
! scope="row" | GPIO
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>gpio-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=936ee2675eee1faca0dcdfa79165c7990422e0fc]
|-
! scope="row" | pinctrl
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
|
|
|-
! scope="row" | Thermal Regulation
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-thermal</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4b14c055a6f644cbeb1156ba24647e92fe51ec69]
|-
! scope="row" | PCIe
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>pcie-dw-rockchip</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0e898eb8df4e34c7b129452444eb7cef68a11f43]
|-
! scope="row" | Power Management
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rockchip-pm-domains</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1782c87b44a0b1a527f01a6a184677c58ccbf9c7]
|-
! scope="row" | Voltage Control
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>rk3568-pmu-io-voltage-domain</code>
| As of 5.15[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=28b05a64e47cbceebb8a5f3f643033148d5c06c3]
|-
! scope="row" | SPI
| colspan="2" style="background:PaleGreen; text-align:center;"|Linux Mainline
| <code>spi-rockchip</code>
| As of 5.14[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d74d99229f4d48f42d674f7a8a1137179efd67ac]. Necessary device tree changes [https://patchwork.kernel.org/project/linux-rockchip/list/?series=586691 in review].
|-
! scope="row" | Battery
| colspan="2" style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=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]
|
|-
! scope="row" | NPU
| colspan="2" style="background:#F99; text-align:center;"|Needs writing
|
| Downstream version is a closed source SDK. Major undertaking to reimplement this as Linux does not (yet) appear to have a generic architecture for neural accelerators.
|
|-
! scope="row" | Crypto
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rk-crypto</code> v2
| Downstream driver [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/crypto/rockchip] doesn't include a rk3568 compatible either, but the TRM shows that it seemingly matches.
|
|}

== Current Status ==

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

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

=== Working ===

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

=== Partially Working ===

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

=== Confirmed Broken ===

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

=== Needs Testing ===

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

== TODO ==

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

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

=== Investigate MCU ===

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

=== Mainline U-Boot Work ===

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

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

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

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

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

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

Stretch Goals:

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

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

=== eDP Driver Porting ===

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

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

== Linux Kernel Config Options ==

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

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

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

=== Other ===

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

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

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

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

==== Bootloader Flashing ====

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

==== BSP Image Layout ====

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

Quartz64 Development

2022-05-12T08:02:20Z

Herostrat: vop2 in linux-next

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;"|linux-next[https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?id=604be85547ce4d61b89292d2f9a78c721b778c16]
| <code>rockchipdrm/VOP2</code>
|
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:#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" rowspan="3" | Video Decode
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=614265]
| 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 and MPEG-4
|
|-
| 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="3" | [[Mainline Hardware Encoding|Video Encode]]
| style="background:LightYellow; text-align:center;"|In review[https://patchwork.kernel.org/project/linux-rockchip/list/?series=640635]
| style="text-align:center; background:LightYellow;"|GStreamer only
| JPEG on VEPU121
|
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.264 on VEPU540
|
|
|-
| style="background:#F99; text-align:center;"|Needs writing
| style="text-align:center;"|?
| H.265 on VEPU540
|
|
|-
! 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:LightYellow; text-align:center;"|linux-next[https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?id=c37415f55bdadffe5b4c0e7981e9fc7e8b96beea]
| Quartz64 Model B
|
| Quartz64 Model B
|-
| 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=c466828fb3ba8cb7f5c3bf28766da9b70bf9745e]
| 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]
|
|-
! scope="row" | NPU
| colspan="2" style="background:#F99; text-align:center;"|Needs writing
|
| Downstream version is a closed source SDK. Major undertaking to reimplement this as Linux does not (yet) appear to have a generic architecture for neural accelerators.
|
|-
! scope="row" | Crypto
| colspan="2" style="background:#F99; text-align:center;"|Needs porting
| <code>rk-crypto</code> v2
| Downstream driver [https://gitlab.com/pine64-org/quartz-bsp/rockchip-linux/-/tree/quartz64/drivers/crypto/rockchip] doesn't include a rk3568 compatible either, but the TRM shows that it seemingly matches.
|
|}

== Current Status ==

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

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

=== Working ===

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

=== Partially Working ===

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

=== Confirmed Broken ===

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

=== Needs Testing ===

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

== TODO ==

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

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

=== Investigate MCU ===

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

=== Mainline U-Boot Work ===

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

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

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

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

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

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

Stretch Goals:

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

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

=== eDP Driver Porting ===

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

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

== Linux Kernel Config Options ==

* <code>CONFIG_SND_SOC_ROCKCHIP_I2S_TDM</code>
** for Analog and (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]]

PineCube

2020-12-15T19:42:44Z

Herostrat:

{{note|1=PAGE UNDER CONSTRUCTION, INFO SUBJECT TO CHANGE}}

== Specifications ==
* '''Dimensions:''' 55mm x 51mm x 51.5mm
* '''Weight:''' 55g
* '''Storage:'''
** MicroSD slot, bootable
** 128Mb SPI Nor Flash, bootable
* '''Cameras:''' OV5640, 5Mpx
* '''CPU:''' Allwinner(Sochip) ARM Cortex-A7 MPCore, 800MHz
* '''RAM:''' 128MB DDR3
* '''I/O:'''
** 10/100Mbps Ethernet with passive PoE
** USB 2.0 A host
** 26 pins GPIO port
*** 2x 3.3V Ouptut
*** 2x 5V Output
*** 1x I2C
*** 2x UART
*** 2x PWM
*** 1x SPI
*** 1x eMMC/SDIO/SD (8-bit)
*** 6x Interrupts
*** '''Note: Interfaces are multiplexed, so they can't be all used at same time'''
** Internal microphone
* '''Network:'''
** WiFi
* '''Screen:''' optional 4.5" RGB LCD screen
* '''Misc. features:'''
** Volume and home buttons
** Speakers and Microphone
* '''Power DC in:'''
** 5V 1A from MicroUSB Port or GPIO port
** 4V-18V from Ethernet passive PoE
* '''Battery:''' optional 950-1600mAh model: 903048 Lithium Polymer Ion Battery Pack, can be purchase at [https://www.amazon.com/AKZYTUE-1200mAh-Battery-Rechargeable-Connector/dp/B07TWHHCNK/ Amazon.com]

== PineCube board information, schematics and certifications ==
* PineCube mainboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20MainBoard%20Schematic%20ver%201.0-20200727.pdf PineCube mainboard Released Schematic ver 1.0]
* PineCube faceboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20FaceBoard%20Schematic%20ver%201.0-20200727.pdf PineCube faceboard Released Schematic ver 1.0]
* PineCube certifications:
** [https://files.pine64.org/doc/cert/PineCube-FCC-SDOC%20certification%20S20072502302001.pdf PineCube FCC Certificate]
** [https://files.pine64.org/doc/cert/PineCube-CE-EMC%20certification%20S20072502301001.pdf PineCube CE RED Certificate]
** [https://files.pine64.org/doc/cert/PineCube-ROHS%20Test%20Report.pdf PineCube ROHS Test Report]

== Datasheets for components and peripherals ==
* Allwinner (Sochip) S3 SoC information:
** [https://files.pine64.org/doc/datasheet/pinecube/S3_Datasheet_V1.1-20180123.pdf Sochip S3 SoC Data Sheet V1.1]

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

* CMOS camera module information:
** [https://files.pine64.org/doc/datasheet/pinecube/CH-5A-DV-V2.0%20Specification.pdf PineCube Camera Module Specification]
** [https://files.pine64.org/doc/datasheet/pinephone/OV5640_datasheet.pdf OV5640 5MP CMOS Image Sensor SoC datasheet]

* LCD touch screen panel information:

* Lithium battery information:

* WiFi/BT module information:
** [https://files.pine64.org/doc/datasheet/pinecube/rtl8189es.pdf RTL8189ES specification]

* GPIO Header Pinout: ([[:File:PineCube_GPIO.pdf|PDF]], [https://pine64.gami.ee/pinecube/gpio-pinout.html HTML])
[[File:PineCube_GPIO_Pinout.png|700px]]

* Case information:
** [https://files.pine64.org/doc/PineCube/PineCube%20Case%203D.zip PinePhone 3D file]

[[File:PineCube_Case-1.jpg|400px]] [[File:PineCube_Case-2.jpg|400px]]

== Operating Systems ==

=== Mainlining Efforts ===

Please note:

* this list is most likely not complete
* no review of functionality is done here, it only serves as a collection of efforts

{| class="wikitable"
!colspan="3"|Linux kernel
|-
| Type
| Link
| Available in version
|-
| Devicetree Entry Pinecube
| https://lkml.org/lkml/2020/9/22/1241
| 5.10
|-
| Correction for AXP209 driver
| https://lkml.org/lkml/2020/9/22/1243
| 5.9
|-
| Additional Fixes for AXP209 driver
| https://lore.kernel.org/lkml/20201031182137.1879521-8-contact@paulk.fr/
| tdb (5.11?)
|-
| Device Tree Fixes
| https://lore.kernel.org/lkml/20201003234842.1121077-1-icenowy@aosc.io/
| 5.10
|-
!colspan="3"|U-boot
|-
| Type
| Link
| Available in version
|-
| PineCube Board Support
| https://patchwork.ozlabs.org/project/uboot/list/?series=210044
| expected in v2021.01
|-
!colspan="3"|Buildroot
|-
| No known mainlining efforts yet
|
|
|}

=== NixOS ===

* [https://github.com/danielfullmer/pinecube-nixos danielfullmer's Github]

=== Buildroot ===
[https://elimo.io Elimo Engineering] integrated support for the PineCube into Buildroot.

This has not been merged into upstream Buildroot yet, but you can find the repo on [https://github.com/elimo-engineering/buildroot Elimo's GitHub account] and build instructions in the [https://github.com/elimo-engineering/buildroot/tree/pine64/pinecube/board/pine64/pinecube board support directory] readme.
The most important thing that this provides is support for the S3's DDR3 in u-boot. Unfortunately mainline u-boot does not have that yet, but the u-boot patches from [https://github.com/danielfullmer/pinecube-nixos Daniel Fullmer's NixOS repo] were easy enough to use on buildroot.
This should get you a functional system that boots to a console on UART0. It's pretty fast too, getting there in 1.5 seconds from u-boot to login prompt.

=== Armbian ===
Armbian Builds for PineCube are [https://www.armbian.com/pinecube/ available for download], once again thanks to [https://github.com/armbian/build/pull/2364/files the work] of Icenowy Zheng.
Although not officially supported ([https://www.armbian.com/download/?device_support=No+official+support+(CSC) CSC Status] it enables the usage of Debian and Ubuntu.

A serial console can be established with 1520008N1 (no hardware flow control). Login credentials are as usual in Armbian root 1234.

=== Stock Linux ===

== SDK ==

==== Stock Linux ====
* [https://files.pine64.org/SDK/PineCube/PineCube%20Stock%20BSP-SDK%20ver1.0.7z Direct Download from pine64.org]
** MD5 (7zip file): efac108dc98efa0a1f5e77660ba375f8
** File Size: 3.50GB
===== How to compile =====

You can either setup a machine for the build environment, or use a Vagrant virtual machine provided by [https://elimo.io Elimo Engineering]

====== On a dedicated machine ======

Recommended system requirements:
* OS: (L)Ubuntu 16.04
* CPU: 64-bit based
* Memory: 8 GB or higher
* Disk: 15 GB free hard disk space

'''Install required packages'''
<pre>
sudo apt-get install p7zip-full git make u-boot-tools libxml2-utils bison build-essential gcc-arm-linux-gnueabi g++-arm-linux-gnueabi zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 lib32z1-dev
</pre>
'''Install older Make 3.82 and Java JDK 6'''
<pre>
pushd /tmp
wget https://ftp.gnu.org/gnu/make/make-3.82.tar.gz
tar xfv make-3.82.tar.gz
cd make-3.82
./configure
make
sudo apt purge -y make
sudo ./make install
cd ..
# Please, download jdk-6u45-linux-x64.bin from https://www.oracle.com/java/technologies/javase-java-archive-javase6-downloads.html (requires free login)
chmod +x jdk-6u45-linux-x64.bin
./jdk-6u45-linux-x64.bin
sudo mkdir /opt/java/
sudo mv jdk1.6.0_45/ /opt/java/
sudo update-alternatives --install /usr/bin/javac javac /opt/java/jdk1.6.0_45/bin/javac 1
sudo update-alternatives --install /usr/bin/java java /opt/java/jdk1.6.0_45/bin/java 1
sudo update-alternatives --install /usr/bin/javaws javaws /opt/java/jdk1.6.0_45/bin/javaws 1
sudo update-alternatives --config javac
sudo update-alternatives --config java
sudo update-alternatives --config javaws
popd
</pre>
'''Unpack SDK and then compile and pack the image'''
<pre>
7z x 'PineCube Stock BSP-SDK ver1.0.7z'
mv 'PineCube Stock BSP-SDK ver1.0' pinecube-sdk
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

====== Using Vagrant ======

You can avoid setting up your machine and just use Vagrant to spin up a development environment in a VM.

Just clone the [https://github.com/elimo-engineering/pinecube-sdk-vagrant Elimo Engineering repo] and follow the instructions in the [https://github.com/elimo-engineering/pinecube-sdk-vagrant/blob/main/README.md readme file]

After spinning up the VM, you just need to run the build:
<pre>
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

== Community Projects ==

Share your project with a PineCube here!

[[Category:PineCube]] [[Category:Allwinner(Sochip) S3]]

PineCube

2020-12-15T18:36:57Z

Herostrat:

{{note|1=PAGE UNDER CONSTRUCTION, INFO SUBJECT TO CHANGE}}

== Specifications ==
* '''Dimensions:''' 55mm x 51mm x 51.5mm
* '''Weight:''' 55g
* '''Storage:'''
** MicroSD slot, bootable
** 128Mb SPI Nor Flash, bootable
* '''Cameras:''' OV5640, 5Mpx
* '''CPU:''' Allwinner(Sochip) ARM Cortex-A7 MPCore, 800MHz
* '''RAM:''' 128MB DDR3
* '''I/O:'''
** 10/100Mbps Ethernet with passive PoE
** USB 2.0 A host
** 26 pins GPIO port
*** 2x 3.3V Ouptut
*** 2x 5V Output
*** 1x I2C
*** 2x UART
*** 2x PWM
*** 1x SPI
*** 1x eMMC/SDIO/SD (8-bit)
*** 6x Interrupts
*** '''Note: Interfaces are multiplexed, so they can't be all used at same time'''
** Internal microphone
* '''Network:'''
** WiFi
* '''Screen:''' optional 4.5" RGB LCD screen
* '''Misc. features:'''
** Volume and home buttons
** Speakers and Microphone
* '''Power DC in:'''
** 5V 1A from MicroUSB Port or GPIO port
** 4V-18V from Ethernet passive PoE
* '''Battery:''' optional 950-1600mAh model: 903048 Lithium Polymer Ion Battery Pack, can be purchase at [https://www.amazon.com/AKZYTUE-1200mAh-Battery-Rechargeable-Connector/dp/B07TWHHCNK/ Amazon.com]

== PineCube board information, schematics and certifications ==
* PineCube mainboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20MainBoard%20Schematic%20ver%201.0-20200727.pdf PineCube mainboard Released Schematic ver 1.0]
* PineCube faceboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20FaceBoard%20Schematic%20ver%201.0-20200727.pdf PineCube faceboard Released Schematic ver 1.0]
* PineCube certifications:
** [https://files.pine64.org/doc/cert/PineCube-FCC-SDOC%20certification%20S20072502302001.pdf PineCube FCC Certificate]
** [https://files.pine64.org/doc/cert/PineCube-CE-EMC%20certification%20S20072502301001.pdf PineCube CE RED Certificate]
** [https://files.pine64.org/doc/cert/PineCube-ROHS%20Test%20Report.pdf PineCube ROHS Test Report]

== Datasheets for components and peripherals ==
* Allwinner (Sochip) S3 SoC information:
** [https://files.pine64.org/doc/datasheet/pinecube/S3_Datasheet_V1.1-20180123.pdf Sochip S3 SoC Data Sheet V1.1]

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

* CMOS camera module information:
** [https://files.pine64.org/doc/datasheet/pinecube/CH-5A-DV-V2.0%20Specification.pdf PineCube Camera Module Specification]
** [https://files.pine64.org/doc/datasheet/pinephone/OV5640_datasheet.pdf OV5640 5MP CMOS Image Sensor SoC datasheet]

* LCD touch screen panel information:

* Lithium battery information:

* WiFi/BT module information:
** [https://files.pine64.org/doc/datasheet/pinecube/rtl8189es.pdf RTL8189ES specification]

* GPIO Header Pinout: ([[:File:PineCube_GPIO.pdf|PDF]], [https://pine64.gami.ee/pinecube/gpio-pinout.html HTML])
[[File:PineCube_GPIO_Pinout.png|700px]]

* Case information:
** [https://files.pine64.org/doc/PineCube/PineCube%20Case%203D.zip PinePhone 3D file]

[[File:PineCube_Case-1.jpg|400px]] [[File:PineCube_Case-2.jpg|400px]]

== Operating Systems ==

=== Mainlining Efforts ===

Please note:

* this list is most likely not complete
* no review of functionality is done here, it only serves as a collection of efforts

{| class="wikitable"
!colspan="3"|Linux kernel
|-
| Type
| Link
| Available in version
|-
| Devicetree Entry Pinecube
| https://lkml.org/lkml/2020/9/22/1241
| 5.10
|-
| Correction for AXP209 driver
| https://lkml.org/lkml/2020/9/22/1243
| 5.9
|-
| Additional Fixes for AXP209 driver
| https://lore.kernel.org/lkml/20201031182137.1879521-8-contact@paulk.fr/
| tdb (5.11?)
|-
| Device Tree Fixes
| https://lore.kernel.org/lkml/20201003234842.1121077-1-icenowy@aosc.io/
| 5.10
|-
!colspan="3"|U-boot
|-
| Type
| Link
| Available in version
|-
| PineCube Board Support
| https://patchwork.ozlabs.org/project/uboot/list/?series=210044
| expected in v2021.01
|-
!colspan="3"|Buildroot
|-
| No known mainlining efforts yet
|
|
|}

=== NixOS ===

* [https://github.com/danielfullmer/pinecube-nixos danielfullmer's Github]

=== Buildroot ===
[https://elimo.io Elimo Engineering] integrated support for the PineCube into Buildroot.

This has not been merged into upstream Buildroot yet, but you can find the repo on [https://github.com/elimo-engineering/buildroot Elimo's GitHub account] and build instructions in the [https://github.com/elimo-engineering/buildroot/tree/pine64/pinecube/board/pine64/pinecube board support directory] readme.
The most important thing that this provides is support for the S3's DDR3 in u-boot. Unfortunately mainline u-boot does not have that yet, but the u-boot patches from [https://github.com/danielfullmer/pinecube-nixos Daniel Fullmer's NixOS repo] were easy enough to use on buildroot.
This should get you a functional system that boots to a console on UART0. It's pretty fast too, getting there in 1.5 seconds from u-boot to login prompt.

=== Armbian ===
Armbian Builds for PineCube are [https://www.armbian.com/pinecube/ available for download], once again thanks to [https://github.com/armbian/build/pull/2364/files the work] of Icenowy Zheng.
Although not officially supported ([https://www.armbian.com/download/?device_support=No+official+support+(CSC) CSC Status] it enables the usage of Debian and Ubuntu.

=== Stock Linux ===

== SDK ==

==== Stock Linux ====
* [https://files.pine64.org/SDK/PineCube/PineCube%20Stock%20BSP-SDK%20ver1.0.7z Direct Download from pine64.org]
** MD5 (7zip file): efac108dc98efa0a1f5e77660ba375f8
** File Size: 3.50GB
===== How to compile =====

You can either setup a machine for the build environment, or use a Vagrant virtual machine provided by [https://elimo.io Elimo Engineering]

====== On a dedicated machine ======

Recommended system requirements:
* OS: (L)Ubuntu 16.04
* CPU: 64-bit based
* Memory: 8 GB or higher
* Disk: 15 GB free hard disk space

'''Install required packages'''
<pre>
sudo apt-get install p7zip-full git make u-boot-tools libxml2-utils bison build-essential gcc-arm-linux-gnueabi g++-arm-linux-gnueabi zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 lib32z1-dev
</pre>
'''Install older Make 3.82 and Java JDK 6'''
<pre>
pushd /tmp
wget https://ftp.gnu.org/gnu/make/make-3.82.tar.gz
tar xfv make-3.82.tar.gz
cd make-3.82
./configure
make
sudo apt purge -y make
sudo ./make install
cd ..
# Please, download jdk-6u45-linux-x64.bin from https://www.oracle.com/java/technologies/javase-java-archive-javase6-downloads.html (requires free login)
chmod +x jdk-6u45-linux-x64.bin
./jdk-6u45-linux-x64.bin
sudo mkdir /opt/java/
sudo mv jdk1.6.0_45/ /opt/java/
sudo update-alternatives --install /usr/bin/javac javac /opt/java/jdk1.6.0_45/bin/javac 1
sudo update-alternatives --install /usr/bin/java java /opt/java/jdk1.6.0_45/bin/java 1
sudo update-alternatives --install /usr/bin/javaws javaws /opt/java/jdk1.6.0_45/bin/javaws 1
sudo update-alternatives --config javac
sudo update-alternatives --config java
sudo update-alternatives --config javaws
popd
</pre>
'''Unpack SDK and then compile and pack the image'''
<pre>
7z x 'PineCube Stock BSP-SDK ver1.0.7z'
mv 'PineCube Stock BSP-SDK ver1.0' pinecube-sdk
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

====== Using Vagrant ======

You can avoid setting up your machine and just use Vagrant to spin up a development environment in a VM.

Just clone the [https://github.com/elimo-engineering/pinecube-sdk-vagrant Elimo Engineering repo] and follow the instructions in the [https://github.com/elimo-engineering/pinecube-sdk-vagrant/blob/main/README.md readme file]

After spinning up the VM, you just need to run the build:
<pre>
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

== Community Projects ==

Share your project with a PineCube here!

[[Category:PineCube]] [[Category:Allwinner(Sochip) S3]]

PineCube

2020-12-02T19:49:39Z

Herostrat:

{{note|1=PAGE UNDER CONSTRUCTION, INFO SUBJECT TO CHANGE}}

== Specifications ==
* '''Dimensions:''' 55mm x 51mm x 51.5mm
* '''Weight:''' 55g
* '''Storage:'''
** MicroSD slot, bootable
** 128Mb SPI Nor Flash, bootable
* '''Cameras:''' OV5640, 5Mpx
* '''CPU:''' Allwinner(Sochip) ARM Cortex-A7 MPCore, 800MHz
* '''RAM:''' 128MB DDR3
* '''I/O:'''
** 10/100Mbps Ethernet with passive PoE
** USB 2.0 A host
** 26 pins GPIO port
*** 2x 3.3V Ouptut
*** 2x 5V Output
*** 1x I2C
*** 2x UART
*** 2x PWM
*** 1x SPI
*** 1x eMMC/SDIO/SD (8-bit)
*** 6x Interrupts
*** '''Note: Interfaces are multiplexed, so they can't be all used at same time'''
** Internal microphone
* '''Network:'''
** WiFi
* '''Screen:''' optional 4.5" RGB LCD screen
* '''Misc. features:'''
** Volume and home buttons
** Speakers and Microphone
* '''Power DC in:'''
** 5V 1A from MicroUSB Port or GPIO port
** 4V-18V from Ethernet passive PoE
* '''Battery:''' optional 950-1600mAh model: 903048 Lithium Polymer Ion Battery Pack, can be purchase at [https://www.amazon.com/AKZYTUE-1200mAh-Battery-Rechargeable-Connector/dp/B07TWHHCNK/ Amazon.com]

== PineCube board information, schematics and certifications ==
* PineCube mainboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20MainBoard%20Schematic%20ver%201.0-20200727.pdf PineCube mainboard Released Schematic ver 1.0]
* PineCube faceboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20FaceBoard%20Schematic%20ver%201.0-20200727.pdf PineCube faceboard Released Schematic ver 1.0]
* PineCube certifications:
** [https://files.pine64.org/doc/cert/PineCube-FCC-SDOC%20certification%20S20072502302001.pdf PineCube FCC Certificate]
** [https://files.pine64.org/doc/cert/PineCube-CE-EMC%20certification%20S20072502301001.pdf PineCube CE RED Certificate]
** [https://files.pine64.org/doc/cert/PineCube-ROHS%20Test%20Report.pdf PineCube ROHS Test Report]

== Datasheets for components and peripherals ==
* Allwinner (Sochip) S3 SoC information:
** [https://files.pine64.org/doc/datasheet/pinecube/S3_Datasheet_V1.1-20180123.pdf Sochip S3 SoC Data Sheet V1.1]

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

* CMOS camera module information:
** [https://files.pine64.org/doc/datasheet/pinecube/CH-5A-DV-V2.0%20Specification.pdf PineCube Camera Module Specification]
** [https://files.pine64.org/doc/datasheet/pinephone/OV5640_datasheet.pdf OV5640 5MP CMOS Image Sensor SoC datasheet]

* LCD touch screen panel information:

* Lithium battery information:

* WiFi/BT module information:
** [https://files.pine64.org/doc/datasheet/pinecube/rtl8189es.pdf RTL8189ES specification]

* GPIO Header Pinout: ([[:File:PineCube_GPIO.pdf|PDF]], [https://pine64.gami.ee/pinecube/gpio-pinout.html HTML])
[[File:PineCube_GPIO_Pinout.png|700px]]

== Operating Systems ==

=== Mainlining Efforts ===

Please note:

* this list is most likely not complete
* no review of functionality is done here, it only serves as a collection of efforts

{| class="wikitable"
!colspan="3"|Linux kernel
|-
| Type
| Link
| Available in version
|-
| Devicetree Entry Pinecube
| https://lkml.org/lkml/2020/9/22/1241
| expected in 5.10
|-
| Correction for AXP209 driver
| https://lkml.org/lkml/2020/9/22/1243
| 5.9
|-
| Additional Fixes for AXP209 driver
| https://lore.kernel.org/lkml/20201031182137.1879521-8-contact@paulk.fr/
| ??
|-
| Device Tree Fixes
| https://lore.kernel.org/lkml/20201003234842.1121077-1-icenowy@aosc.io/
| expected in 5.10
|-
| Ethernet Alias for WiFi
| https://lore.kernel.org/lkml/20201124225940.3750388-1-icenowy@aosc.io/
| ??
|-
!colspan="3"|U-boot
|-
| Type
| Link
| Available in version
|-
| PineCube Board Support
| https://patchwork.ozlabs.org/project/uboot/list/?series=210044
| expected in v2021.01
|-
!colspan="3"|Buildroot
|-
| No known mainlining efforts yet
|
|
|}

=== NixOS ===

* [https://github.com/danielfullmer/pinecube-nixos danielfullmer's Github]

=== Buildroot ===
[https://elimo.io Elimo Engineering] integrated support for the PineCube into Buildroot.

This has not been merged into upstream Buildroot yet, but you can find the repo on [https://github.com/elimo-engineering/buildroot Elimo's GitHub account] and build instructions in the [https://github.com/elimo-engineering/buildroot/tree/pine64/pinecube/board/pine64/pinecube board support directory] readme.
The most important thing that this provides is support for the S3's DDR3 in u-boot. Unfortunately mainline u-boot does not have that yet, but the u-boot patches from [https://github.com/danielfullmer/pinecube-nixos Daniel Fullmer's NixOS repo] were easy enough to use on buildroot.
This should get you a functional system that boots to a console on UART0. It's pretty fast too, getting there in 1.5 seconds from u-boot to login prompt.

=== Stock Linux ===

== SDK ==

==== Stock Linux ====
* [https://files.pine64.org/SDK/PineCube/PineCube%20Stock%20BSP-SDK%20ver1.0.7z Direct Download from pine64.org]
** MD5 (7zip file): efac108dc98efa0a1f5e77660ba375f8
** File Size: 3.50GB
===== How to compile =====

You can either setup a machine for the build environment, or use a Vagrant virtual machine provided by [https://elimo.io Elimo Engineering]

====== On a dedicated machine ======

Recommended system requirements:
* OS: (L)Ubuntu 16.04
* CPU: 64-bit based
* Memory: 8 GB or higher
* Disk: 15 GB free hard disk space

'''Install required packages'''
<pre>
sudo apt-get install p7zip-full git make u-boot-tools libxml2-utils bison build-essential gcc-arm-linux-gnueabi g++-arm-linux-gnueabi zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 lib32z1-dev
</pre>
'''Install older Make 3.82 and Java JDK 6'''
<pre>
pushd /tmp
wget https://ftp.gnu.org/gnu/make/make-3.82.tar.gz
tar xfv make-3.82.tar.gz
cd make-3.82
./configure
make
sudo apt purge -y make
sudo ./make install
cd ..
# Please, download jdk-6u45-linux-x64.bin from https://www.oracle.com/java/technologies/javase-java-archive-javase6-downloads.html (requires free login)
chmod +x jdk-6u45-linux-x64.bin
./jdk-6u45-linux-x64.bin
sudo mkdir /opt/java/
sudo mv jdk1.6.0_45/ /opt/java/
sudo update-alternatives --install /usr/bin/javac javac /opt/java/jdk1.6.0_45/bin/javac 1
sudo update-alternatives --install /usr/bin/java java /opt/java/jdk1.6.0_45/bin/java 1
sudo update-alternatives --install /usr/bin/javaws javaws /opt/java/jdk1.6.0_45/bin/javaws 1
sudo update-alternatives --config javac
sudo update-alternatives --config java
sudo update-alternatives --config javaws
popd
</pre>
'''Unpack SDK and then compile and pack the image'''
<pre>
7z x 'PineCube Stock BSP-SDK ver1.0.7z'
mv 'PineCube Stock BSP-SDK ver1.0' pinecube-sdk
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

====== Using Vagrant ======

You can avoid setting up your machine and just use Vagrant to spin up a development environment in a VM.

Just clone the [https://github.com/elimo-engineering/pinecube-sdk-vagrant Elimo Engineering repo] and follow the instructions in the [https://github.com/elimo-engineering/pinecube-sdk-vagrant/blob/main/README.md readme file]

After spinning up the VM, you just need to run the build:
<pre>
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

[[Category:PineCube]] [[Category:Allwinner(Sochip) S3]]

PineCube

2020-12-02T19:38:23Z

Herostrat: Updated Kernel Upstreaming Effort

{{note|1=PAGE UNDER CONSTRUCTION, INFO SUBJECT TO CHANGE}}

== Specifications ==
* '''Dimensions:''' 55mm x 51mm x 51.5mm
* '''Weight:''' 55g
* '''Storage:'''
** MicroSD slot, bootable
** 128Mb SPI Nor Flash, bootable
* '''Cameras:''' OV5640, 5Mpx
* '''CPU:''' Allwinner(Sochip) ARM Cortex-A7 MPCore, 800MHz
* '''RAM:''' 128MB DDR3
* '''I/O:'''
** 10/100Mbps Ethernet with passive PoE
** USB 2.0 A host
** 26 pins GPIO port
*** 2x 3.3V Ouptut
*** 2x 5V Output
*** 1x I2C
*** 2x UART
*** 2x PWM
*** 1x SPI
*** 1x eMMC/SDIO/SD (8-bit)
*** 6x Interrupts
*** '''Note: Interfaces are multiplexed, so they can't be all used at same time'''
** Internal microphone
* '''Network:'''
** WiFi
* '''Screen:''' optional 4.5" RGB LCD screen
* '''Misc. features:'''
** Volume and home buttons
** Speakers and Microphone
* '''Power DC in:'''
** 5V 1A from MicroUSB Port or GPIO port
** 4V-18V from Ethernet passive PoE
* '''Battery:''' optional 950-1600mAh model: 903048 Lithium Polymer Ion Battery Pack, can be purchase at [https://www.amazon.com/AKZYTUE-1200mAh-Battery-Rechargeable-Connector/dp/B07TWHHCNK/ Amazon.com]

== PineCube board information, schematics and certifications ==
* PineCube mainboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20MainBoard%20Schematic%20ver%201.0-20200727.pdf PineCube mainboard Released Schematic ver 1.0]
* PineCube faceboard schematic:
** [https://files.pine64.org/doc/PineCube/PineCube%20FaceBoard%20Schematic%20ver%201.0-20200727.pdf PineCube faceboard Released Schematic ver 1.0]
* PineCube certifications:
** [https://files.pine64.org/doc/cert/PineCube-FCC-SDOC%20certification%20S20072502302001.pdf PineCube FCC Certificate]
** [https://files.pine64.org/doc/cert/PineCube-CE-EMC%20certification%20S20072502301001.pdf PineCube CE RED Certificate]
** [https://files.pine64.org/doc/cert/PineCube-ROHS%20Test%20Report.pdf PineCube ROHS Test Report]

== Datasheets for components and peripherals ==
* Allwinner (Sochip) S3 SoC information:
** [https://files.pine64.org/doc/datasheet/pinecube/S3_Datasheet_V1.1-20180123.pdf Sochip S3 SoC Data Sheet V1.1]

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

* CMOS camera module information:
** [https://files.pine64.org/doc/datasheet/pinecube/CH-5A-DV-V2.0%20Specification.pdf PineCube Camera Module Specification]
** [https://files.pine64.org/doc/datasheet/pinephone/OV5640_datasheet.pdf OV5640 5MP CMOS Image Sensor SoC datasheet]

* LCD touch screen panel information:

* Lithium battery information:

* WiFi/BT module information:
** [https://files.pine64.org/doc/datasheet/pinecube/rtl8189es.pdf RTL8189ES specification]

* GPIO Header Pinout: ([[:File:PineCube_GPIO.pdf|PDF]], [https://pine64.gami.ee/pinecube/gpio-pinout.html HTML])
[[File:PineCube_GPIO_Pinout.png|700px]]

== Operating Systems ==

=== Mainlining Efforts ===

{| class="wikitable"
!colspan="3"|Linux kernel
|-
| Type
| Link
| Available in version
|-
| Devicetree Entry Pinecube
| https://lkml.org/lkml/2020/9/22/1241
| expected in 5.10
|-
| Correction for AXP209 driver
| https://lkml.org/lkml/2020/9/22/1243
| 5.9
|-
| Device Tree Fixes
| https://lore.kernel.org/lkml/20201003234842.1121077-1-icenowy@aosc.io/
| expected in 5.10
|-
| Ethernet Alias for WiFi
| https://lore.kernel.org/lkml/20201124225940.3750388-1-icenowy@aosc.io/
| ??
|-
!colspan="3"|U-boot
|-
| Type
| Link
| Available in version
|-
| PineCube Board Support
| https://patchwork.ozlabs.org/project/uboot/list/?series=210044
| expected in v2021.01
|-
!colspan="3"|Buildroot
|-
|
|
|
|}

=== NixOS ===

* [https://github.com/danielfullmer/pinecube-nixos danielfullmer's Github]

=== Buildroot ===
[https://elimo.io Elimo Engineering] integrated support for the PineCube into Buildroot.

This has not been merged into upstream Buildroot yet, but you can find the repo on [https://github.com/elimo-engineering/buildroot Elimo's GitHub account] and build instructions in the [https://github.com/elimo-engineering/buildroot/tree/pine64/pinecube/board/pine64/pinecube board support directory] readme.
The most important thing that this provides is support for the S3's DDR3 in u-boot. Unfortunately mainline u-boot does not have that yet, but the u-boot patches from [https://github.com/danielfullmer/pinecube-nixos Daniel Fullmer's NixOS repo] were easy enough to use on buildroot.
This should get you a functional system that boots to a console on UART0. It's pretty fast too, getting there in 1.5 seconds from u-boot to login prompt.

=== Stock Linux ===

== SDK ==

==== Stock Linux ====
* [https://files.pine64.org/SDK/PineCube/PineCube%20Stock%20BSP-SDK%20ver1.0.7z Direct Download from pine64.org]
** MD5 (7zip file): efac108dc98efa0a1f5e77660ba375f8
** File Size: 3.50GB
===== How to compile =====

You can either setup a machine for the build environment, or use a Vagrant virtual machine provided by [https://elimo.io Elimo Engineering]

====== On a dedicated machine ======

Recommended system requirements:
* OS: (L)Ubuntu 16.04
* CPU: 64-bit based
* Memory: 8 GB or higher
* Disk: 15 GB free hard disk space

'''Install required packages'''
<pre>
sudo apt-get install p7zip-full git make u-boot-tools libxml2-utils bison build-essential gcc-arm-linux-gnueabi g++-arm-linux-gnueabi zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 lib32z1-dev
</pre>
'''Install older Make 3.82 and Java JDK 6'''
<pre>
pushd /tmp
wget https://ftp.gnu.org/gnu/make/make-3.82.tar.gz
tar xfv make-3.82.tar.gz
cd make-3.82
./configure
make
sudo apt purge -y make
sudo ./make install
cd ..
# Please, download jdk-6u45-linux-x64.bin from https://www.oracle.com/java/technologies/javase-java-archive-javase6-downloads.html (requires free login)
chmod +x jdk-6u45-linux-x64.bin
./jdk-6u45-linux-x64.bin
sudo mkdir /opt/java/
sudo mv jdk1.6.0_45/ /opt/java/
sudo update-alternatives --install /usr/bin/javac javac /opt/java/jdk1.6.0_45/bin/javac 1
sudo update-alternatives --install /usr/bin/java java /opt/java/jdk1.6.0_45/bin/java 1
sudo update-alternatives --install /usr/bin/javaws javaws /opt/java/jdk1.6.0_45/bin/javaws 1
sudo update-alternatives --config javac
sudo update-alternatives --config java
sudo update-alternatives --config javaws
popd
</pre>
'''Unpack SDK and then compile and pack the image'''
<pre>
7z x 'PineCube Stock BSP-SDK ver1.0.7z'
mv 'PineCube Stock BSP-SDK ver1.0' pinecube-sdk
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

====== Using Vagrant ======

You can avoid setting up your machine and just use Vagrant to spin up a development environment in a VM.

Just clone the [https://github.com/elimo-engineering/pinecube-sdk-vagrant Elimo Engineering repo] and follow the instructions in the [https://github.com/elimo-engineering/pinecube-sdk-vagrant/blob/main/README.md readme file]

After spinning up the VM, you just need to run the build:
<pre>
cd pinecube-sdk/camdroid
source build/envsetup.sh
lunch
mklichee
make -j3
pack
</pre>

[[Category:PineCube]] [[Category:Allwinner(Sochip) S3]]

PineCube

2020-10-16T18:08:48Z

Herostrat: add section with mainlining effort