PINE64 - User contributions [en]

Pinebook Pro

2020-06-12T14:04:17Z

Oxoocoffee:

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

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

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

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

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

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

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

== Software and OS Image Downloads ==

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

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

On first boot, it will ask for certain information such as your timezone location, keyboard layout, username, password, and hostname. Most of these should be self-explanatory. Note that the hostname it asks for should be thought of as the "codename" of your machine, and if you don't know what it's about, you can make something up.

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

=== [[Pinebook Pro_Software_Release|Pinebook Pro images]] ===
Under [[Pinebook Pro Software Release|'Pinebook Pro Software and OS Image Download Section']] you will find a complete list of currently supported Operating System images that work with the Pinebook as well as other related software.

The list includes OS images and descriptions of:

[{{fullurl:PinebookPro_Software_Release#Manjaro_ARM}} [[File:Manjaro.png|125px]]] [[PinebookPro_Software_Release#Manjaro ARM|'''Manjaro ARM (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Debian_Desktop}} [[File:Debian.png|125px]]] [[PinebookPro_Software_Release#Debian Desktop|'''Debian Desktop (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Bionic_LXDE}} [[File:Lxde.png|125px]]] [[PinebookPro_Software_Release#Bionic LXDE|'''Bionic LXDE (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Bionic_Mate}} [[File:Mate.png|125px]]] [[PinebookPro_Software_Release#Bionic Mate|'''Bionic Mate (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Fedora}} [[File:Fedora1.png|125px]]] [[PinebookPro_Software_Release#Fedora|'''Fedora (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#OpenSUSE}} [[File:Opensuse1.png|125px]]] [[PinebookPro_Software_Release#OpenSUSE|'''OpenSUSE (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Q4OS}} [[File:Q4os.png|125px]]] [[PinebookPro_Software_Release#Q4OS|'''Q4OS (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Armbian}} [[File:Armbian.png|125px]]] [[PinebookPro_Software_Release#Armbian|'''Armbian (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#NetBSD}} [[File:Netbsd.png|125px]]] [[PinebookPro_Software_Release#NetBSD|'''NetBSD (microSD and eMMC Boot)''']]

[{{fullurl:Pinebook_Pro_Software_Release#OpenBSD}} [[File:Puffy_mascot_openbsd.png|125px]]] [[Pinebook_Pro_Software_Release#OpenBSD|'''OpenBSD release for ARM64''']]

[{{fullurl:PinebookPro_Software_Release#Chromium}} [[File:Chromium.jpg|125px]]] [[PinebookPro_Software_Release#Chromium|'''Chromium (microSD and eMMC Boot)''']]

[{{fullurl:PinebookPro_Software_Release#Android_7.1_microSD}} [[File:Android_7.png|125px]]] [[PinebookPro_Software_Release#Android_7.1_microSD|'''Android 7.1 (microSD Boot)''']]           [{{fullurl:PinebookPro_Software_Release#Android_7.1_eMMC}} [[File:Android_7.png|125px]]] [[PinebookPro_Software_Release#Android_7.1_eMMC|'''Android 7.1 (eMMC)''']]

[{{fullurl:PinebookPro_Software_Release#Daniel_Thompson.27s_Debian_Installer_for_the_Pinebook_Pro}} [[File:Debian.png|125px]]] [[PinebookPro_Software_Release#Daniel_Thompson.27s_Debian_Installer_for_the_Pinebook_Pro|'''Debian Installer for Pinebook Pro''']]

[{{fullurl:Pinebook_Pro_Software_Release#Gentoo_Script_for_Pinebook_Pro}} [[File:Gentoo.png|125px]]]
[[Pinebook_Pro_Software_Release#Gentoo_Script_for_Pinebook_Pro|'''Gentoo Script for Pinebook Pro''']]

[{{fullurl:PinebookPro_Software_Release#Kali_Linux_for_Pinebook_Pro}} [[File:Kali.jpeg|125px]]] [[PinebookPro_Software_Release#Kali_Linux_for_Pinebook_Pro|'''Kali Script for Pinebook Pro (microSD and eMMC Boot)''']]

=== Quick Links to OS Images Build Sources===
'''Some of the provided OS images are still in beta or nightly build and only fit for testing purposes. These images ought to be avoided for normal usage - use them at your own risk'''
* [https://github.com/ayufan-rock64/linux-build/releases/ ayufan's Linux build repo]
* [https://github.com/ayufan-rock64/chromiumos-build/releases ayufan's Chromium OS build repo]
* [https://github.com/mrfixit2001/debian_desktop/releases mrfixit2001's Linux debian desktop build repo]

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

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

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

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

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

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

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

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

== Trackpad ==
The trackpad is a reasonable size, has a matte finish that that your finger can slide along easily, and two actuating buttons. It is the only component of the Pinebook Pro held in place with strong adhesive tape. It supports multi-touch functionality.
Documentation for the trackpad can be found in [[#Datasheets for Components and Peripherals|Datasheets for Components and Peripherals]].
The trackpad firmware binary can be flashed from userspace using the provided open source utility (https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater). A fork with more recent changes is also available (https://github.com/jackhumbert/pinebook-pro-keyboard-updater) and may want to be considered instead while feature parity is different.

'''Everyone with a Pinebook Pro produced in 2019 should update their keyboard and trackpad firmware.'''

Before you start:

Please refer to original documentation for details.

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

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

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

What you will need:

*Your Pinebook Pro fully charged or running off of mains power
*Connection to WiFi
*An external USB keyboard & mouse. Or access to the Pinebebook Pro via SSH

'''ISO Model'''

From the terminal command line:

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

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 iso
sudo reboot
</pre>

Step 2 (after reboot)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 iso
sudo reboot
</pre>

----

'''ANSI Model'''

*NOTE: Running step-1 on the ansi keyboard model will make the keyboard and trackpad inaccessible until step-2 is run, so an external keyboard must be connected to complete the update on this model!

From the terminal command line:

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

Step 1
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-1 ansi
sudo reboot
</pre>

Step 2 (after reboot)
<pre>
cd pinebook-pro-keyboard-updater
sudo ./updater step-2 ansi
sudo reboot
</pre>
When done, if some of the keys produce in-correct characters, please check your OSes' language settings. For ANSI users, the default OS shipped with English UK as the default language. You can change it to English US if desired.

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

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

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

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

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

:1. The red LED next to the barrel-port indicates charging. It will illuminate when mains power is supplied to the Pinebook Pro from either the standard power supply unit or a USB-C smartphone charger.

:2. The power indicator LED on the Pinebook Pro supports three different colours: green, amber and red. It is also capable of flashing/blinking to indicate activity. In the default Debian with MATE build, green LED means power and red means suspend (amber is unused).

:3. The Num lock, green LED.

:4. The Caps lock, green LED.

(The Num and Caps lock LEDs have a secondary function. When the privacy switches get activated they blink to confirm that switch has been activated.)

== Webcam ==
* Streaming video resolutions supported, (un-compressed):
** 320 x 240
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Still frame resolutions supported:
** 160 x 120
** 176 x 144
** 320 x 240
** 352 x 288
** 640 x 480
** 800 x 600
** 1280 x 720
** 1600 x 1200
* Some people test with the application Cheese
WIP

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

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

'''Microphones not working?'''

If pavucontrol input doesn't show microphone activity try the [[Pinebook_Pro#Privacy_Switches]]; once that is set to on do the below; if that still hasn't fixed it you may want to check that the microphone connector is plugged in (see the [[Pinebook_Pro#Technical_Reference]]).

<pre>
run alsamixer from the command line > hit F6 and select the es8316 > hit F4 to get to the capture screen > select the bar labeled ADC >
> increase the gain to 0dB > change the audio profile in pavucontrol to another with input

Additionally:
you may want to modify ADC PGA to get the levels to where you want them
</pre>

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

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

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

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

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

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

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

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

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

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

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

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

===Disabling Bluetooth===
<pre>
#disable bluetooth once
sudo rfkill block bluetooth &&

#confirm
rfkill
</pre>

<pre>
#disable bluetooth on boot**
sudo systemctl enable rfkill-block@bluetooth
</pre>

<nowiki>**This does not do what one might want on certain distros, Manjaro XFCE for example. Try the below.</nowiki>

<pre>
right click on the bluetooth panel icon > select 'plugins' > PowerManager > configuration > deselect the auto power on option
</pre>

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

Some people have tested hardware video decode using the following;
<pre>ffmpeg -benchmark -c:v h264_rkmpp -i file.mp4 -f null -</pre>

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

== Using the UART ==
[[File:PBPUART.jpeg|400px|thumb|right|Headphone jack UART wiring reference.
 Swapping the tx and rx around from this also works and is more traditional.
 See [http://files.pine64.org/doc/pinebook/guide/Pinebook_Earphone_Serial_Console_Developer_Guide.pdf this] official Pine64 .pdf.]]

UART output is enabled by flipping the UART switch to the ON position (item 9). To do so you need to remove the Pinebook Pro's bottom cover - please follow [https://wiki.pine64.org/index.php/Pinebook_Pro_Main_Page#Accessing_the_Internals_-_Disassembly_and_Reassembly proper disassembly and reassembly protocol]. The OFF position is towards the touchpad, the ON position is towards the display hinges.

With the UART switch in the ON position, console is relayed via the audiojack and the laptop's sound is turned OFF. Please ensure that you are using a 3.3v interface (such as the CH340, FTDI-232R, or PL2303, which are sold in both 3.3v and 5v variants) to avoid damage to the CPU.

Insert the USB plug of the cable into an open USB port on the machine which will monitor. Run the following in a terminal:

<code>
$ lsusb
</code>

you should find a line similar to this:

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

You may have to clean the USB contacts of the Serial cable to get a good connection if you do not find that line.

The audio jack of the Serial cable should be fully inserted into the Pinebook Pro audio port.

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

<code>
screen /dev/ttyUSB0 1500000

picocom /dev/ttyUSB0 -b 1500000

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

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

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

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

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

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

Actual installation instructions are a work in progress.

=== Post NVMe install power limiting ===
Some NVMe SSDs allow reducing the maximum amount of power. Doing so may reduce the speed, but it may be needed in the Pinebook Pro to both improve reliability at lower battery levels. And to reduce power used, to maintain battery life.
Here are the commands to obtain and change the power settings. The package 'nvme-cli' is required to run these commands. The example shows how to find the available power states, and then sets it to the lowest, non-standby setting, (which is 3.8 watts for the device shown);
<pre>$ sudo nvme id-ctrl /dev/nvme0
NVME Identify Controller:
...
ps 0 : mp:9.00W operational enlat:0 exlat:0 rrt:0 rrl:0
rwt:0 rwl:0 idle_power:- active_power:-
ps 1 : mp:4.60W operational enlat:0 exlat:0 rrt:1 rrl:1
rwt:1 rwl:1 idle_power:- active_power:-
ps 2 : mp:3.80W operational enlat:0 exlat:0 rrt:2 rrl:2
rwt:2 rwl:2 idle_power:- active_power:-
ps 3 : mp:0.0450W non-operational enlat:2000 exlat:2000 rrt:3 rrl:3
rwt:3 rwl:3 idle_power:- active_power:-
ps 4 : mp:0.0040W non-operational enlat:6000 exlat:8000 rrt:4 rrl:4
rwt:4 rwl:4 idle_power:- active_power:-

$ sudo nvme get-feature /dev/nvme0 -f 2
get-feature:0x2 (Power Management), Current value:00000000
$ sudo nvme set-feature /dev/nvme0 -f 2 -v 2 -s
set-feature:02 (Power Management), value:0x000002</pre>
Some NVMe SSDs don't appear to allow saving the setting with "-s" option. In those cases, leave off the "-s" and use a startup script to set the non-default power state at boot. 
If you want to test performance without saving the new power setting semi-permanantly, then leave off the "-s" option. 
 
There is another power saving feature for NVMes, APST, (Autonomous Power State Transitions). This performs the power saving & transitions based on usage. To check if you have a NVMe SSD with this feature;
<pre>$ sudo nvme get-feature -f 0x0c -H /dev/nvme0</pre>
Information for this feature, (on a Pinebook Pro), is a work in progress.

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

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

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

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

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

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

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

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

WARNING: Do not connect the bypass cables with the battery connected. Using the bypass cables with the battery connected can permanently damage the computer.

=== [[Pinebook_Service_Step_by_Step_Guides|Pinebook Service Step-by-Step Guides]] ===
Placeholder for Pinebook Pro specific guides

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

'''Note: The installation process on Pinebook Pro similar to 14" Pinebook'''

'''Note: The installation process is the reverse order of removal guide'''

* 14″ Pinebook Lithium Battery Pack Removal Guide
* 14″ Pinebook LCD Panel Screen Removal Guide
* 14″ Pinebook eMMC Module Removal Guide

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

Here is some information on using the SPI flash device:

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

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

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

== FAQ ==
What cool software works out of the box? [[Pinebook Pro OTB Experience]]

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

== Customizing the Pinebook Pro's default Manjaro KDE system ==
=== Watching DRM content (Netflix, etc.) ===
Most paid online streaming services use Widevine DRM to make their content more difficult to pirate. Widevine is not directly supported on Manjaro KDE, however it is still possible to watch DRM content via the "chromium-docker" package which downloads a 32-bit ARM container and installs Chromium with Widevine inside of that. While not space-efficient, or efficient in general, it's the recommended solution for watching this content on your Pinebook Pro. You can install this package with:
<pre>sudo pacman -Sy chromium-docker</pre>
=== Checking GPU capabilities ===
To see what versions of OpenGL and OpenGL ES are supported by the Pinebook Pro, what driver is in use, and what version of the driver is loaded, install the "mesa-demos" package with:
<pre>sudo pacman -Sy mesa-demos</pre>
And then run:
<pre>glxinfo | grep OpenGL</pre>
This will give detailed information about your graphics card and driver, useful for debugging.

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

=== OpenGL ES 3.0 support ===
By default, with the current state of the Panfrost GPU driver, the Pinebook Pro supports OpenGL 2.1 and OpenGL ES 2.0. If you want to use OpenGL ES 3.0, you'll first need to install the "mesa-git" package (as documented above). Then, to set the system-wide environment variable, open the '''/etc/environment''' file with:
<pre>kate /etc/environment</pre>
And then at the bottom of the file, on a new line, add:
<pre>PAN_MESA_DEBUG="gles3"</pre>
Then save the file, entering your password when prompted, and reboot the system. When you check your GPU capabilities, it should report OpenGL ES 3.0 and applications that rely on it should function properly. Note that GLES3 support is currently incomplete and some advanced rendering features may still not work properly.
== Customizing the Pinebook Pro's previously-default Debian system ==
Here are some hints on what you can do to customize the Pinebook Pro's previous factory image (aka [https://github.com/mrfixit2001/debian_desktop mrfixit2001 debian build])

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

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

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

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

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

Perform the following steps:

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

=== Changing the boot splash picture ===

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

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

=== Enabling text boot time messages ===

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

Default Debian
* Backup and edit the U-Boot configuration file:
<pre>cp -p /etc/default/u-boot /etc/default/u-boot.`date +%Y%m%d`
chmod a-w /etc/default/u-boot.`date +%Y%m%d`
vi /etc/default/u-boot</pre>
Remove the '''quiet''' and '''splash''' parameters. Leave everything else alone.
* Update the U-Boot configuration:
<pre>u-boot-update</pre>
* Test and verify you get what you think you should be seeing.
 
Manjaro
* Backup and edit the U-Boot configuration file:
<pre>cp -p /boot/extlinux/extlinux.conf /boot/extlinux/extlinux.conf.`date +%Y%m%d`
chmod a-w /boot/extlinux/extlinux.conf.`date +%Y%m%d`
vi /boot/extlinux/extlinux.conf</pre>
Remove the '''bootsplash.bootfile''' option and it's parameter. Leave everything else alone. 
You can add verbose logging by appending '''ignore_loglevel''' to the line where boot splash was.
* Test and verify you get what you think you should be seeing.

== Improving readability ==

Some people find that a 14" LCD screen with 1080p, (1920 x 1080), has text and icons a bit too small. There are things you can do to make the screen easier to use & read. 
* Increase the font size
* Use a font with more pronounce features
* Increase the various window manager sizes, (like increase the height of the tool bar)
* Change the color scheme to be easier on the eyes, (even though it may not be bigger, proper contrast can help usability)
* Change the window manager's decorations, (like using larger icons)
* Use a workspace manager, (so one application per workspace)
* When at home or office, use an external monitor
* Changing the X-Window's DPI, (Dot's Per Inch), can help too
 
However, do not change the resolution of the LCD screen, otherwise you may end up with a blank / black screen. If that happens, see this trouble shooting section for the fix: 
[[Pinebook_Pro#After_changing_builtin_LCD_resolution.2C_blank_screen|Blank screen after changing builtin LCD resolution]]

== Chromium tweaks ==

=== Flags ===

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

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

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

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

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

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

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

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

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

= Troubleshooting guide =
Tips, tricks and other information for troubleshooting your Pinebook Pro
=== New from the factory - Pinebook Pro won't boot / power on ===
* Some Pinebook Pros came from the factory with the eMMC switch in the disabled position. It should be switched towards the back / hinge to enable the eMMC. 
* The eMMC may have come loose during shipment. [https://wiki.pine64.org/index.php/Pinebook_Pro_Main_Page#Accessing_the_Internals_-_Disassembly_and_Reassembly Open] the back and verify that the eMMC is firmly seated. 
* You may want to try unplugging the SD card daughterboard ribbon cable and see if it powers on (remove the battery and peel off a bit of the tape before unplugging it to avoid damage). If it does, try reseating it on both sides. It might have come loose during shipping.
* It's possible that your eMMC is empty from the factory. Simply create a bootable SD card and see if your Pinebook Pro boots. If so, you can then write an OS image to the eMMC.

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

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

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

=== WiFi issues ===
* First, check the privacy switches to make sure your WiFi is enabled. They are persistant. See [[Pinebook_Pro_Main_Page#Privacy_Switches|Privacy Switches]]
* Next, you may have to modify the <code>/etc/NetworkManager/NetworkManager.conf</code> as root user, and replace <code>managed=false</code> with <code>managed=true</code>. Then reboot.
* For connections that drop and resume too often, it might be due to WiFi power management from earlier OS releases. Later OS releases either removed WiFi power management, or default to full power. (Power management can be turned off via command line with <code>iw dev wlan0 set power_save off</code> or <code>iwconfig wlan0 power off</code>, although it is not persistent through re-boot.)
* For connections that drop under load on the default Debian, remove <code>iwconfig wlan0 power off</code> in the file <code>/etc/rc.local</code>.
* If WiFi is un-usable or often crashes when using an alternate OS, then it might because its WiFi firmware is not appropriate for the WiFi chip in the Pinebook Pro. Try the latest firmware patch from [https://gitlab.manjaro.org/tsys/pinebook-firmware/tree/master/brcm https://gitlab.manjaro.org/tsys/pinebook-firmware/tree/master/brcm]
* After re-enabling WiFi via the privacy switch, you have to reboot to restore function. There is a work around for the default Debian, (and may work with others);
        <code>sudo tee /sys/bus/platform/drivers/dwmmc_rockchip/{un,}bind <<< 'fe310000.dwmmc'</code>

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

=== Sound issues ===
* Many reports of no sound are due to the OS, incorrect settings, or other software problems (eg. PulseAudio). So first test to see if it is a software or hardware problem, by trying another OS via SD card. (For example, if Debian is installed on the eMMC, try Ubuntu on SD.)
* If you cannot get sound from the headphone jack, but can get sound from the speakers, then the headphone / UART console switch may be set to the UART mode. You can open the back and check the position of the switch. If set to UART mode, switch it to headphone mode. See the parts layout for the location and correct position of the switch.
* When using the USB C alternate DisplayPort mode, it is possible that the audio has been re-directed through this path. If your monitor has speakers, see if they work.
* See [https://gitlab.manjaro.org/manjaro-arm/packages/community/pinebookpro-post-install/blob/master/asound.state manjaro-arm/pinebookpro-post-install /var/lib/alsa/asound.state] for some ALSA tweaks.
* See [https://gitlab.manjaro.org/manjaro-arm/packages/community/pinebookpro-audio manjaro-arm/pinebookpro-audio] for how to handle 3.5mm jack plug/unplug events with ACPID.
* Serveral users have reported that one internal speaker had reversed polarity. Thus, sound from the speakers is like an echo effect.
** Their is a software fix using alsamixer and then enable either "R invert" or "L invert", however, now the headphones have incorrect audio.
** The permanent fix is to re-wire one speaker, though this requires soldering small wires.

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

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

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

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

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

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

=== Pinebook Pro gets stuck after first reboot in Trackpad Firmware Update ===
This refers to the firmware update shown here:
https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater#update-all-firmwares
* If the system is not responding after the 1st reboot, it's might be easiest to do a system restore, and follow up by running the second step of the trackpad firmware update.
* System restore https://forum.pine64.org/showthread.php?tid=8229
* Firmware update https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater#update-all-firmwares

=== ANSI Fn + F keys wrong for F9, F10, F11 and F12 ===
There appears to be a minor firmware issue for ANSI keyboard models of the Pinebook Pro. Some discussion and fixes have been proposed;

* Discussion thread [https://forum.pine64.org/showthread.php?tid=8744&pid=57678#pid57678 Fn + F keys screwy for F9, F10, F11 and F12]
* Proposed fix [https://github.com/ayufan-rock64/pinebook-pro-keyboard-updater/issues/14#issuecomment-576825396 (ANSI) Fn + F(9-12) has wrong assignment after firmware update #14]
  

=== After changing builtin LCD resolution, blank screen ===
Some people find that the text or icons are too small, so they attempt to change the resolution of the built-in display. Afterwards, the display is blank. 
Use the following to fix when logged into a text console as yourself, (Control-Alt-F1 through F6). After listing the resolutions, select the native resolution, (1920x1080 aka 1080p).
<pre>export DISPLAY=:0.0
xrandr -q
xrandr -s [resolution]</pre>
Once your resolution is restored, try using the Tweak app to set scaling, instead. 
 
If the above fix did not work, you can try this:
* Using a text console, (Control-Alt-F1), login with your normal user ID
* Edit the file <code>nano ~/.config/monitors.xml</code>
* Change the "width" value to "1920"
* Change the "height" value to "1080"
* If there is more than one monitor configuration listed, edit that one too. Be careful to make no other changes. If needed, exit without saving and re-edit.
* Save the file and exit.
* Login using the GUI and test
* If you are still loggied in via the GUI, you will have to reboot using <code>sudo shutdown -r now</code> After the reboot, you should be able to login to the GUI login and have the resolution back to normal.
When you have restored usability to your Pinebook Pro's graphical screen, see this section on improving readability and usability: 
[[Pinebook_Pro#Improving_readability|Improving readability]]

=== Cracks in the plastic ===
There have been multiple reports of cracks in the plastic keyboard & trackpad part of the case. These are generally near here;
* Hinges
* USB ports
* Top side, around the corners
This seems to apply to the first batches in 2019. Later versions of the keyboard & trackpad have used better plastic. With replacements now in the Pine64 Store, it's possible to simply order a replacement. 
 
There have been a few reports of cracks in the plastic around the LCD display, but these appear to be less common. There are replacement LCDs with bezel available in the Pine64 Store.

= [[Pinebook_Pro_Hardware_Accessory_Compatibility|PineBookPro Hardware Compatibility]] =

Please contribute to the hardware compatibility page, which lists hardware which has been tested with the PBP, whether successful or not!

* [[Pinebook_Pro_Hardware_Accessory_Compatibility#NVMe_SSD_drives|NVMe SSD drives]]
* [[Pinebook_Pro_Hardware_Accessory_Compatibility#USB_hardware|USB hardware]]
* [[Pinebook_Pro_Hardware_Accessory_Compatibility#USB_C_alternate_mode_DP|USB C alternate mode DP]]
* [[Pinebook_Pro_Hardware_Accessory_Compatibility#Other_hardware|Other hardware]]
  
 

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

'''WARNING:''' Do not open the laptop by lifting the lid while the Pinebook Pro bottom cover is removed - this can cause structural damage to the hinges and/or other plastic components of the chassis such as the IO port cut-outs.

'''WARNING:''' When removing the back cover plate, use care if sliding fingertips between back cover plate and palm rest assembly. The back cover plate edges are sharp.

When disassembling the laptop make sure that it is powered off and folded closed. To remove the bottom cover of the Pinebook Pro, first remove the ten (10) Phillips head screws that hold the bottom section of the laptop in place. Remove the cover from the back where the hinges are situated by lifting it up and away from the rest of the chassis.

During reassembly, make sure that the back-screw standoffs are in place and seated correctly. To reassemble the Pinebook Pro, slide the bottom section into place so it meets the front lip of the keyboard section. Secure the front section (where the trackpad is located) in place using the short screws in the front left and right corners. Then proceed to pop in the bottom panel into place. Secure the bottom section (where hinges are located) by screwing in the left and right corners. Then screw in the remaining screws and run your finger though the rim on the chassis to make sure its fitted correctly. Note that the front uses the remaining 2 short screws.

NOTE: The screws are small and should only be finger tight. Too much force will strip the threads. If after installing screws the back cover plate has not seated properly on one side, open the display and hold the base on either side of the keyboard and gently flex the base with both hands in opposing directions. Once the side pops further in, then recheck the screws on that side. If it does not pop back in, just let it be.

NOTE: a basic 3d model to print replacement back-screw standoffs is available on Thingiverse [https://www.thingiverse.com/thing:4226648] pending release of something more definitive

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

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

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

[[File:PBPL_S.jpg]]

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

=== Smallboard detailed picture ===

[[File:Pinebook_pro_smallboard.jpg]]

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

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

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

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

=== eMMC information ===
The eMMC appears to be hot-pluggable. This can be useful if trying to recover data or a broken install. Best practice is probably to turn the eMMC switch to off position before changing modules.

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

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

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

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

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

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

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

=== GPU Architecture ===
* [https://developer.arm.com/products/graphics-and-multimedia/mali-gpus/mali-t860-and-mali-t880-gpus ARM Mali-T860MP4 Quad-core GPU]
* The highest performance GPUs built on Arm Mali’s famous Midgard architecture, the Mali-T860 GPU is designed for complex graphics use cases and provide stunning visuals for UHD content.
* Frequency 650MHz
* Throughput 1300Mtri/s, 10.4Gpix/s
* OpenGL® ES 1.1, 1.2, 2.0, 3.0, 3.1, 3.2., Vulkan 1.0*., OpenCL™ 1.1, 1.2., DirectX® 11 FL11_1., RenderScript™.

=== System Memory ===
* RAM Memory:
** LPDDR4
** Dual memory channels on the CPU, each 32 bits wide
** Quad memory channels on the RAM chip, each 16 bits wide, 2 bonded together for each CPU channel
** 4GB as a single 366 pin mobile RAM chip
* Storage Memory:
** 64GB eMMC module, can be upgraded to a 128GB eMMC module. (The initial PINE64 community build version shipped with a 128GB eMMC.)
** eMMC version 5.1, HS400, 8 bit on RK3399 side

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

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

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

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

=== Display ===
* 14.0" 1920x1080 IPS LCD panel

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

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

=== Optional NVMe adapter ===
* PCIe 2.x, 5GT/s per lane
* 4 PCIe lanes, can not be bifurcated, (however, can be used with 1 or 2 lane NVMe cards)
* '''M''' keyed, though '''M'''+'''B''' keyed devices will work too
* Maximum length for M.2 card is 80mm (M.2 2280). The following sizes will also work: 2230, 2242, 2260
* Power: 2.5W continuous, 8.25W peak momentary
* Does not support SATA M.2 cards
* Does not support USB M.2 cards

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

== Datasheets for Components and Peripherals ==
* Rockchip RK3399 SoC information:
** [http://www.rock-chips.com/a/en/products/RK33_Series/2016/0419/758.html Rockchip RK3399 SoC Brief]
** [http://opensource.rock-chips.com/images/d/d7/Rockchip_RK3399_Datasheet_V2.1-20200323.pdf Rockchip RK3399 Datasheet V2.1]
** [http://opensource.rock-chips.com/images/e/ee/Rockchip_RK3399TRM_V1.4_Part1-20170408.pdf Rockchip RK3399 Technical Reference Manual part 1]
** [http://files.pine64.org/doc/datasheet/rockpro64/RK808%20datasheet%20V0.8.pdf Rockchip RK808 Datasheet V0.8]
* LPDDR4 (366 Balls) SDRAM:
** [http://files.pine64.org/doc/datasheet/PinebookPro/micron%20SM512M64Z01MD4BNK-053FT%20LPDDR4%20(366Ball).pdf Micron 366 balls Mobile LPDDR4 Datasheet]
* eMMC information:
** [http://files.pine64.org/doc/rock64/PINE64_eMMC_Module_20170719.pdf PINE64 eMMC module schematic]
** [http://files.pine64.org/doc/rock64/usb%20emmc%20module%20adapter%20v2.pdf PINE64 USB adapter for eMMC module V2 schematic]
** [http://files.pine64.org/doc/rock64/USB%20adapter%20for%20eMMC%20module%20PCB.tar PINE64 USB adapter for eMMC module PCB in JPEG]
** [http://files.pine64.org/doc/datasheet/pine64/SDINADF4-16-128GB-H%20data%20sheet%20v1.13.pdf SanDisk eMMC Datasheet]
* SPI NOR Flash information:
** [http://files.pine64.org/doc/datasheet/pine64/w25q128jv%20spi%20revc%2011162016.pdf WinBond 128Mb SPI Flash Datasheet]
** [https://wiki.pine64.org/images/b/b9/Ds-00220-gd25q127c-rev1-df2f4.pdf GigaDevice 128Mb SPI Flash Datasheet (UPDATED)]
* Wireless related info:
** [http://files.pine64.org/doc/datasheet/PinebookPro/AP6256%20datasheet_V1.7_12282018.pdf AMPAK AP6256 11AC Wi-Fi + Bluetooth5 Datasheet]
* Audio Codec (ES8316)
** [http://everest-semi.com/pdf/ES8316%20PB.pdf Everest ES8316 Audio Codec]
* LCD Panel:
** [http://files.pine64.org/doc/datasheet/PinebookPro/NV140FHM-N49_Rev.P0_20160804_201710235838.pdf 14" 1920x1080 IPS LCD Panel datasheet]
* Internal USB 2 hub:
** [https://wiki.pine64.org/images/3/39/GL850G_USB_Hub_1.07.pdf GL850G USB Hub 1.07.pdf]
* Touchpad information:
** [http://files.pine64.org/doc/datasheet/PinebookPro/YX%20HK-9562%20HID%20I2C%20Specification.pdf Touchpad Specification for Pinebook Pro model]
* Keyboard information:
** [https://wiki.pine64.org/images/b/b0/SH68F83V2.0.pdf Sinowealth SH68F83 Datasheet]
** US ANSI: XK-HS002 MB27716023
* Full HD Camera sensor:
** [http://files.pine64.org/doc/datasheet/PinebookPro/HK-2145-263.pdf Full HD Camera module specification in Chinese]
** [http://files.pine64.org/doc/datasheet/PinebookPro/GC2145%20CSP%20DataSheet%20release%20V1.0_20131201.pdf GalaxyCore GC2145 Full HD Camera Sensor Data Sheet]
* Lithium Battery information:
** [http://files.pine64.org/doc/datasheet/pinebook/40110175P%203.8V%2010000mAh规格书-14.pdf 10000mAH Lithium Battery Specification for 14" model]
* NVMe adapter:
** [https://datasheet.octopart.com/FH26W-35S-0.3SHW%2860%29-Hirose-datasheet-26676825.pdf Compatible, not OEM! Use FH26-35S-0.3SHW flat flex connector]

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

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

= Other Resources =
* [https://forum.pine64.org/forumdisplay.php?fid=111 Pinebook Pro Forum]
* [https://forum.pine64.org/forumdisplay.php?fid=98 ROCKPro64 Forum]
* [[RockPro64 Guides]]
* [https://riot.im/app/#/room/#pinebook:matrix.org Matrix Channel] (No login required to read)
* [http://www.pine64.xyz:9090/?channels=ROCK64 ROCK64/ROCKPro64 IRC Channel]
* [https://discordapp.com/channels/463237927984693259/622348681538043924 Discord Channel]
* [https://github.com/rockchip-linux Rockchip Linux GitHub Repo]
* [http://opensource.rock-chips.com/ Rockchip Open Source Wiki]

Getting started

2020-06-06T19:18:03Z

Oxoocoffee:

[[File:NOOB.png]]

== Setting Up Your device - What You’ll Need to Get Started ==

You will need the following to get started with using your PINE A64(+), SOPine/PINE A64-LTS, Pinebook or ROCK64 board:
* Windows / Linux PC or MAC with a SD Card Reader connected to the Internet.
* For PINE A64(+): Power Supply (PSU) and a micro usb cable. Please make sure to use a PSU rated at +5V @2A and a micro USB cable that is at least 26 AWG thick.
* For SOPine/PINE A64-LTS: Power Supply (PSU) with 3.5mm OD/1.5mm ID barrel DC Jack. Please make sure to use a PSU rated at +5V @2A.
* For Pinebook and ROCK64: Power Supply (PSU) with 3.5mm OD/1.5mm ID barrel DC Jack. Please make sure to use a PSU rated at +5V @3A.
* MicroSD card (8GB or higher capacity) rated 'class 10' or better.
* HDMI cable (unless you wish to run headless / without a monitor). On '''A64 Devices''' Android and Remix OS support 720p and 1080p, while Linux supports a [https://github.com/longsleep/sunxi-disp-tool#available-hdmi-output-names wider range of resolutions].
* Input device(s) such as: keyboard, mouse, remote, pointer, etc.

== A One-Step Solution to Flashing Your MicroSD Card ==
Please try our [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md PINE64 Installer] to easily select the PINE A64(+), SOPINE/PINE A64-LTS, Pinebook or ROCK64 OS of your choice and flash it to your MicroSD Card.

You can also flash an OS image manually; please follow the instructions below.

== Step-by-Step Instructions to Flashing MicroSD Cards ==

'''Caution!'''

Handle the Pine64 Single Board Computers' PCBs with care. Always hold bare boards by the edges and make sure to wear an anti-static wrist strap. Touching components on the front and back of the boards can result in an ESD discharge that may cause damage to the electronics. Avoid placing bare boards on materials such as carpets, plastics or other surfaces prone to electrostatic build-up.

'''Begin by imaging the OS of your choice'''

The process of flashing PINE64 OS images to micro SD on your Windows, Linux or OSX device is the same for all devices. You will require a quality microSD card (8GB or greater; class 10 or faster). There are many [http://forum.pine64.org/showthread.php?tid=681 substandard and counterfeit cards] in circulation and even reputable vendors may unknowingly sell counterfeit microSD cards. Cards that do not meet the criteria outlined above are known to cause a variety of issues including, but not limited to, complete boot failure. There are ways of testing microSD cards prior to installing the operating system to make sure they are appropriate for use with your board. The main utility for checking microSD cards is [http://www.softpedia.com/get/System/System-Miscellaneous/H2testw.shtml#download H2testw 1.4]; yet another alternative is [https://github.com/AltraMayor/f3/archive/v6.0.zip F3]. Yet abother overview of various options [https://www.raymond.cc/blog/test-and-detect-fake-or-counterfeit-usb-flash-drives-bought-from-ebay-with-h2testw/ Test and Detect Fake Cards]

Please refer to the relevant section below for instructions on how to image your microSD card:
* [[#Imaging microSD on Windows 7/8/8.1/10|Imaging microSD on Windows 7/8/8.1/10]]
* [[#Imaging microSD on Apple OSX|Imaging microSD on Apple OSX]]
* [[#Imaging microSD on Linux|Imaging microSD on Linux]]

Having successfully imaged your microSD card, insert it into the microSD slot.

'''Plug in the HDMI Cable, Ethernet Cable and Peripherals to your PINE64 SBC'''

Unless you are planning on running your board headless (without a monitor / as a server) you should plug in all necessary peripherals, including the HDMI and Ethernet cable, prior to powering ON the board. Do note, depending on which OS image you are using, some peripherals may or may not work.

'''Apply Power to Your Board'''

Once you have imaged your microSD and plugged everything in, you are ready to apply power to the PIN64 Single Board Computer. You'll need a good quality 5 Volt, 2 Amp PSU. Using a good quality PSU is very important as failing to meet the required specifications may prevent the board from booting correctly. A marginally higher PSU Voltage is acceptable (for instance, 5.1 volts - due to the nature of the micro usb connection, a 5.1v supply can help protect slightly against voltage drops which can cause undesirable results). However, a significantly higher voltage of 7 Volts or more will damage the PINE64 Single Board Computer and may render it inoperative.

For PINE A64(+) board, if you are using a separate micro USB cable with your PSU, make sure that the cable has a low resistance rating. Cables with high resistance will cause improper function and the unit may not boot at all or only partially. The thicker the internal cabling, the better [http://voyager8.blogspot.co.uk/2013/04/how-to-choose-good-usb-data-and.html i.e. AWG (American Wire Gauge) 20 is better than AWG 28]. In General, '''power-only microUSB''' cables come with red colour USB header.

Having completed the steps outlined above the PINE64 SIngle Board Computer will begin to boot. The onboard power-on LEDs will come on and Ethernet port LEDs will start to blink if you have an Ethenet cable plugged in.

----

=== Imaging microSD on Windows 7/8/8.1/10 ===

You will need the following utilities to get started with imaging the OS of your choice onto your microSD card:
* A compression utility (used to unarchive the OS image). We recommend you use [http://www.7-zip.org/download.html 7zip].
* A disk image utility (used to flash the .img to your SD card). We recommend you use either the [https://etcher.io/ Etcher] or [https://sourceforge.net/projects/win32diskimager/ Win32Imager] utility.

'''Optional for Allwinner A64 SoC based boards'''
* Phoenix Card image utility (used ONLY for phoenix card images). You can download it from [https://drive.google.com/file/d/0B0cEs0lxTtL3VmstaEFfbmU1NFk/view?usp=sharing here].

'''Downloading and extracting OS image(s)'''

You can find OS images for the respective devices in the [http://wiki.pine64.org/index.php/Main_Page device section] on the main page.
Images designated ‘DD’ need to be flashed using Etcher or Win32imager, whilst images labelled ‘Phoenix Card Image’ require the Phoenix Card utility.

Having downloaded the required OS image proceed to use 7zip to unarchive it by right-clicking the archive, and selecting ‘Extract All’. Upon completion, note the destination of where the .img file was extracted (‘Downloads’ folder by default). Once the process has completed, you can proceed to imaging the .img file.

'''Imaging the microSD card (DD)'''

* Insert your microSD card into your laptop/USB card reader. You may require a SD → microSD converter, as most laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer, make sure to take note of the drive it has been assigned (the drive is assigned a letter, e.g. ‘F:’). You will need to remember the ‘letter’ it has been assigned when imaging the OS.

* Launch Win32diskImager.exe or etcher.exe. You will be presented with a field titled ‘path’ and a drop down menu labeled ‘device’. Click the ‘path’, navigate to and select the OS image you extracted from the archive earlier. Next, from the drop-down menu select the drive your microSD has been assigned. '''N.B.''' Pay close attention to the selected drive (remember your letter) – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Having chosen the desired OS image and the correct driver press ‘write’. Once the image has been written to your microSD card you will receive a pop-up notification. Be sure to close the application and to eject/remove your SD card safely from Windows.

'''Imaging using Phoenix Card (applicable only to Allwinner A64 SoC based boards)'''

On Windows, you can also use Phoenix Card (for detailed instructions click [[PhoenixCard|here]]). The Phoenix Card utility works ONLY with images designated as ‘Phoenix Card’ in the downloads section. To use Phoenix Card follow these steps:

* Insert your microSD card into your laptop/USB card reader. You may require a SD → microSD converter, as most laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer, make sure to take note of the drive it has been assigned (the drive is assigned a letter, e.g. ‘F:’). You will need to remember the ‘letter’ it has been assigned when imaging the OS.

* Launch phoenixcard.exe. You will be presented with a ‘disk’ drop-down menu and a field denoted as ‘.img File’. Click on ‘.img File’ and navigate to and select the OS image have downloaded and unarchived. Next, make sure to select the disk that your microSD card has been assigned. '''N.B.''' Pay close attention to the selected drive (remember your letter) – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Make sure to select ‘Startup!’ from the ‘Write mode’ window and click Burn. Once the image has been written to your microSD card you will receive a confirmation in the ‘option’ window. Be sure to close the application and to eject/remove your SD card safely from Windows.

----

=== Imaging microSD on Apple OSX ===

You will need the following utilities to get started with imaging the OS of your choice onto your microSD card:
* A compression Utility (used to unarchive the OS image). We recommend you use [http://www.7-zip.org/download.html 7Zip].
* A disk image utility (used to flash the .img to your SD card in GUI). We recommend you use [http://mac.softpedia.com/get/Utilities/ApplePi-Baker.shtml#download ApplePi Baker] or [https://etcher.io/ Etcher].

'''N.B.''' Phoenix Card utility and images are NOT available on Apple OSX.

'''Downloading and extracting OS image(s)'''

You can find OS images for the respective devices in the [http://wiki.pine64.org/index.php/Main_Page device section] on the main page. On OSX you can only use images designated as ‘DD’.

Having downloaded the required OS image proceed to use 7zip to unarchive it by double clicking the archive, and selecting ‘Extract All’. Upon completion, note the destination where the .img file was extracted (‘Downloads’ folder by default). Once the process has completed, you can proceed to imaging the .img file.

'''Imaging the microSD card (GUI)'''

* Insert your microSD card into your Mac laptop/USB card reader. You may require a SD → microSD converter, as Apple’s laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer it should appear in Finder / on your desktop.

* Launch Apple-Pi Baker or the etcher utility. Upon startup the application it will ask for your password. When the application launches you will be presented with a field titled ‘IMG file’ and a path of the mounted microSD card (it will look something like this: ‘/dev/diskX 32.0Gb SD card’). Click the ‘IMG file’ button, navigate to and select the OS image you extracted from the archive earlier. Next, select the microSD from the window. '''N.B.''' Pay close attention to the selected drive – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Having chosen the desired OS image and the correct driver press ‘Restore Backup’. Once the image has been written to your microSD card you will receive a pop-up notification. Be sure to close the application and to eject/remove your SD card safely from your Mac.

'''Imaging from Terminal'''

'''N.B.''' If you are not comfortable using the terminal, please use the GUI method outlined above instead.

* Insert your microSD card into your Mac laptop/USB card reader. You may require a SD → microSD converter, as Apple’s laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer it should appear in Finder / on your desktop.

* Open up your terminal and navigate to the directory where you unarchived your OS image.

* Before you start writing to the card, you will have to identify your microSD card. Type: diskutil list and note the output. The disk number should match the size of your SD card and will likely be using ‘Fdisk_partition_scheme’. Having identified the disk number execute the following commands (substitute diskX for your disk and name of image for pine64-image-name.img):

''diskutil unmountDisk /dev/diskX
sudo dd if=pine64-image-name.img of=/dev/disk2 bs=1M''

* Wait patiently for the process to complete. Be sure to eject/remove your SD card safely from your Mac.

----

=== Imaging microSD on Linux ===

You will need the following utilities to get started with imaging the OS of your choice onto your microSD card:
* A compression Utility (used to unarchive the OS image). We recommend you use [http://www.7-zip.org/download.html 7Zip].
* A disk image utility (used to flash the .img to your SD card in GUI). We recommend you use [https://etcher.io/ Etcher] or the [https://git.gnome.org/browse/gnome-disk-utility/ GUI Disks utility] that ships with most popular distros.

'''N.B.''' Phoenix Card utility and images are NOT available on Linux.

'''Downloading and extracting OS image(s)'''

You can find OS images for the respective devices in the [http://wiki.pine64.org/index.php/Main_Page device section] on the main page. On Linux you can only use images designated as ‘DD’.

Having downloaded the required OS image proceed to use 7zip to unarchive it by double clicking the archive, and selecting ‘Extract All’. Upon completion, note the destination where the .img file was extracted (‘Downloads’ folder by default). Once the process has completed, you can proceed to imaging the .img file.

'''Imaging the microSD card (GUI)'''

* Insert your microSD card into your Linux laptop/USB card reader. Once the microSD card is plugged into your computer it should appear in your File Manager / on your desktop.

* Launch Disks or the etcher utility (This tutorial outlines how to use Disks, if you wish to learn how to use Etcher please visit [https://etcher.io/ their website]).

* Upon launching Disks, you will be presented with all volumes visible to your computer. As a rule of thumb, your microSD card should be found at the bottom of listed volumes. Verify this by checking the size and mounting of the microSD card. '''N.B.''' Pay close attention to the selected drive – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Having selected your microSD card, click the cog menu in top right corner and choose the ‘Restore Disk Image’ option from the drop-down list. Navigate to and select the OS image you extracted from the archive earlier. Once you select it, you will be asked to enter your password and to confirm writing to the chosen volume (microSD card).

* You will be given a predicted time, writing-speed and completion percentage. Once the image has been written to your microSD card you will receive a pop-up notification. Be sure to close the application and to eject/remove your SD card safely from your computer.

'''Imaging from Terminal'''

'''N.B.''' If you are not comfortable using the terminal, please use the GUI method outlined above instead.

* Insert your microSD card into your Linux laptop/USB card reader. Once the microSD card is plugged into your computer it should appear in Finder / on your desktop.
* Open up your terminal and navigate to the directory where you unarchived your OS image. e.g. <code> cd Download</code>
* Before you start writing to the card, you will have to identify your microSD card.

* Type: <code>lsblk</code> and pay attention to the listed disks. Disks will appear as ''/dev/mmcblk0 /dev/mmcblk1'' etc.
* '''Hint''': the drive you currently have booted from has the <code>/</code> at the end of the line. This is the wrong drive. Look at the drive that matches your microSD card’s size.
* Having located the microSD card use the following command to flash the .img of choice to the microSD card (/dev/sdb used as example): <code>sudo unmount /dev/mmcblk0</code>
* Now you are ready to write the image to the microSD card using this command: (replace the pine.img file with your image and mmcblkX with the correct device for the microSD card)

<code>sudo dd if=pine.img of=/dev/mmcblkX bs=1M status=progress conv=fsync</code>

* Wait patiently for the process to complete.
* use the command <code>sync</code> to ensure everything is written to the microSD card.
* The card is ready to boot

(sometimes this process fails and your microSD card can't boot, one way of fixing this is just to repeat the same thing, you can also try a different microSD card)

== Instructions to Flashing eMMC Modules ==

All PINE64 devices - with the '''notable exception of the original Pine A64(+) SBC''' - support eMMC modules as an alternative boot and storage solution to micro SD cards.
An eMMC module can be purchased for your device(s) from the [https://www.pine64.org/?post_type=product PINE64 store]. The only PINE64 device that ships with an eMMC module by default is the Pinebook.

The available modules come in three different capacities: 16Gb, 32Gb, 64Gb and 128Gb

There are a few ways to flash eMMC modules with the desired OS image. The following sections are a summary of the processes involved in flashing the OS image of your choice to the eMMC module.

----

=== Flashing Using Pine64 Installer (Micro SD-to-eMMC) ===

This may be the simplest way to install an OS image to eMMC, however the selection of images that can be installed using this method is, at the time of writing, very limited.
To flash the OS image to your eMMC using this process you will need the following:

* An SD card of at least 8Gb capacity
* A Windows, Linux or Mac OS computer with the [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md PINE64 installer] installed. The PINE64 Installer is available for all major platforms.
* A SD card reader
* Your PINE64 device with the eMMC module installed

'''The SD-to-eMMC Flashing Process'''

*Begin the process by launching the PINE64 Installer utility and clicking 'Choose an OS'. Next select your device from the drop-down menu. You will be presented with the various OS images available via the utility; you will notice that some of the OS images have '''SDCard to eMMC listed next to them in the brackets'''. Only images with this designation in the brackets will be able to help you flash the image of your choice to eMMC.

*Having selected an OS image put in your microSD card into your SD cardreader and follow the on-screen instructions. The process will flash the SD-to-eMMC installation image to your micro SD card. Once PINE64 Installer has completed the flashing process remove and micro SD card from your computer and place insert it into your PINE64 device.

*Connect a keyboard and HDMI display for the SD-to-eMMC installation process (does not apply to Pinebook). Make sure that both your eMMC module and micro SD card are inserted into your device and apply power to the unit. You will be provided with further instructions on the display as well as a progress bar of the eMMC installation process. Once the process is complete, power down your PINE64 device and remove the micro SD from its socket. You can now boot into your OS image of choice from the eMMC module.

----

=== Flashing Using the USB-to-eMMC Adaptor (Preferred Way) ===

A USB-to-eMMC adaptor is available from purchase from the [https://www.pine64.org/ PIN64 Store] making it easy to mount the eMMC module as a volume in your Windows, Mac OS or Linux computer. The eMMC can hence be flashed directly from your computer with any image similarly to a micro SD card.

'''This installation method works for all devices that support eMMC modules regardless of the chipset''' and it is therefore the preferred way of flashing OS images to eMMC. All available OS images for your device can be installed on the eMMC module this way.

*This process of flashing an OS image to eMMC is '''literally identical to imaging micro SD cards''', so please read [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Step-by-Step Instructions to Flashing Micro SD Cards] before you begin.

For this method you will need the following:

*A Windows, Linux or Mac OS computer
*A PINE64 eMMC module
*The PINE64 USB-to-eMMC adaptor

'''Flashing eMMC using the adaptor'''

*Insert the the eMMC module into the USB adaptor and plug it into your Windows, Linux or Mac OS computer. It should mount as a regular USB drive and show up in your file manager.
*If you are using Linux or Mac OS you can either use the dd terminal command or a GUI utility such as [https://etcher.io/ Etcher] to flash the chosen OS Image to eMMC.
*If you are using a Windows machine use [https://etcher.io/ Etcher] or [https://sourceforge.net/projects/win32diskimager/ Win32 Disk Imager] to flash the OS Image to the eMMC module.

Once the image has been flashed using your preferred method safely dismount the USB adaptor in your system and unplug it from your computer. Your eMMC is now ready to boot and can be inserted into the eMMC socket on your PINE64 device.

----

=== Flashing to eMMC from a SD Boot ===

Some of the available Linux images for Allwinner A64 devices recognise eMMC modules as mounted storage when the device is booted from a micro SD card. This is true for all recent releases of [https://github.com/ayufan-pine64/linux-build/releases ayufan's Linux images]. In result it is possible to flash an OS image to eMMC using the DD command in terminal or the Disks GUI utility included with the Mate desktop.

There are '''two ways''' in which an OS image can be flashed from within a micro SD boot:
*Via a script called Pine64_install_to_eMMC.sh found in ''/usr/local/sbin''. This script will install an Ubuntu Mate OS installation (identical to the on running on the SD) to the eMMC module. To execute the script navigate to its location in the terminal and type ''sudo ./Pine64_install_to_eMMC.sh''. Follow the instructions.

*By manually downloading and flashing a OS image for your device using DD or the Disk GUI. This way of flashing an OS image to the eMMC is identical to that used on a Linux computer (e.g. for flashing an OS image to a SD card). For more information on how the process works please see the detailed guide on [http://wiki.pine64.org/index.php/NOOB#Imaging_microSD_on_Linux imaging OS images to SD card on Linux].

For the latter of the two methods here is a summary of the process:
*Flash an OS image which recognises eMMC as mounted storage to a micro SD card. For details on how to flash a micro SD card see [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards section 3.0]
*Insert both the micro SD and eMMC module into your device and power it on.
*Once the PINE64 device boots from micro SD, open the web browser and download the desired OS image for your device.
*Once the OS image downloads check in terminal or in Disks utility the eMMC's mounting location.
*Use the DD command or Disks utility to flash the downloaded image to the eMMC module.
*Once the flashing process is completed power down your device and remove the micro SD card. You should now be able to power your device back up and it will boot the image flashed to the eMMC module.

----

=== Flashing to eMMC using FEL (Allwinner A64 Devices Only) ===

Under particular circumstances it may prove difficult to rely on a SD card to flash an OS image to an Allwinner A64 device. In such instances OS images can be directly flashed by means of entering into FEL mode. FEL is a low-level subroutine in the BootROM, and the process of enabling FEL differs from one device to another. To learn more about FEL please refer to the [http://linux-sunxi.org/FEL SUNXI Wiki section] dedicated to the subject.

The process of flashing via FEL is more complex than utilising a micro SD and is therefore '''better suited for proficient and advanced users'''.

For the process of flashing an image to the eMMC on a device in FEL mode you will need:
*A computer running Mac OS or Linux
*An OTG USB A-to-A cable

To enter FEL you will need to:
*On the Pinebook, power down the Pinebook and remove the PSU, unscrew the bottom of the case and press down the FEL button on the PCB (REF). Plug in the OTG USB A-to-A cord to your computer and the OTG USB port on the Pinebook (on the right facing an open case). Reinsert the PSU cord and press the power button with the FEL button pressed down. Release the FEL button after 3 seconds.
*On the Pine A64(+) power down the board and remove the micro SD card and power cord. Plug in the OTG USB A-to-A cord to your computer and the OTG USB port on the Pine A64 (+) and SoPine (top port). Power on the device and immediately after insert a micro SD card [https://app.box.com/s/s3m7rb5zfe0jkwqhaiy1zytqq3436fqs with FEL code].

You can check if your device entered FEL mode using ''lsusb'' command in terminal. It should be listed as a device on the USB Bus.

The next step is to mount your device so that your computer recognises the eMMC as mass storage (UMS). A script called boot-tools streamlining this process is available '''thanks to ayufan''' on [https://github.com/ayufan-pine64/boot-tools his github]. Follow his instructions and in terminal perform the following stepps:

*''git clone https://github.com/ayufan-pine64/boot-tools.git
*''cd boot-tools''
*''make pinebook_ums''
or
*''make pine64_ums''

Once your device mounts as UMS it will appear in your file manager. In CLI you can check if the storage is listed using ''fdisk -l''.

This process of flashing an OS image to eMMC with the device in FEL mode and mounted as UMS is '''literally identical to imaging micro SD cards''', so please read [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Step-by-Step Instructions to Flashing Micro SD Cards] and follow the procedure. You can use DD or Disks/ Disk Utility to flash the OS image directly to your device's eMMC.

Once the flashing process is completed, power down your device, remove the A-to-A USB OTG cable and after reapply power to boot your device from eMMC.

----

=== Flashing to eMMC using Rockchip Tools (Rock64 Only) ===

Rockchip has a different boot hierarchy to Allwinner's devices making it much more difficult to flash OS images using the micro SD-to-eMMC scheme used on A64. There are, however, flashing tools that make it possible to flash directly to eMMC on a Rock64 in loader and MarkROM modes.

To flash to the eMMC module using these tools you will need the following:
*A Windows, Mac OS or Linux computer
*An A-to-A USB cable
*The Rock64 board with the eMMC module inserted into the socket

'''Using Windows 7/8.1/10 '''
You will need to download the [https://github.com/rockchip-linux/tools/tree/master/windows DriverAssistant aka Rockchip driver] as well as the [https://github.com/rockchip-linux/tools/tree/master/windows AndroidTool_Release] used for flashing OS images. Having completed the downloads extract both archives.The Rockchip driver needs to be installed prior to using the AndroidTool utility.

Having installed the driver and flashing utility, follow these steps:
*Make sure that eMMC is inserted into the slot on the Rock64
*Place a jumper / short out the eMMC pins on the board (consult [http://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf this document] for more details.
*Insert one end of the A-to-A cable into your Windows PC and the other into your Rock64 OTG USB port (top)
*Inset the power cord into the Rock64
*Start AndroidTool; make sure that it reports 'Found One Maskrom Device' (if it does not recognise your device, please repeat previous steps)
*Select either the latest Stock Android build or ayufan's Android TV build with the suffic -update. Download and the extract the chosen image.
*In AndroidTool press the firmware tab and navigate to where you extracted the OS image and select it.
*Press the upgrade tab. You will be prompted when the flashing process is completed.
*Remove the USB A-to-A cable, power off your board and power it on again to boot into eMMC.

'''Using Linux or Mac OS'''

*Make sure that eMMC is inserted into the slot on the Rock64
*Download latest stable or pre-release (to be used at own risk) Android TV OS image from [https://github.com/ayufan-rock64/android-7.1/releases ayufan's github]. The image you wish to download is the one '''without a suffix'''; without -update or -raw in the OS image title.
*In terminal, download rkflashtool following instructions on [https://github.com/ayufan-rock64/android-7.1/blob/master/README.md ayufan's github]
*Extract the folder containing partitions of the OS image and place the script listed on ayufan's github in the folder
*Hold down the recovery button on the board
*Insert one end of the A-to-A cable into your Mac OS or Linux PC and the other into your Rock64 OTG USB port (top)
*Inset the power cord into the Rock64
*Check that your device is in loader mode by typing in the terminal ''sudo rkflashtool n''. If rkflashtool doesn't detect the Rock64 please repeat last 3 steps
*In terminal navigate to where you extracted the Android folder containing the OS partitions and the script and type ''rkinstall''; this will install the community Android TV build to eMMC.
*Remove the USB A-to-A cable, power off your board and power it on again to boot into eMMC.

----

=== Flashing to eMMC Android 'Update' OS Images on Linux (Rock64 Only) ===

It is possible to flash Android 'update' images to the Rock64 eMMC using a Linux PC. This process requires a tool called [http://www.haoyuelectronics.com/service/RK3066/tools/linux/Linux_Upgrade_Tool_v1.2.tar.gz Linux Upgrade Tool] and the full documentation of its functions can be found [http://www.hotmcu.com/wiki/Flashing_Firmware_Image_Files_Using_The_Rockchip_Tool#Using_Linux_Upgrade_Tool_to_flash_update.img here]. Make sure that you download v1.2 or newer, as older tools do not support the RK3328 used on the Rock64.

To flash to the eMMC module using this method you will need the following:
*A Linux computer
*An A-to-A USB cable
*The Rock64 board with the eMMC module inserted into the socket

Start by downloading an Android '''update''' image for the Rock64. Both PINE64 and Ayufan provide such images for the board - and they are clearly designated as such on both this WiKi's download section and on ayufan's github. For the purpose of this example, I'll use the ayufan's ATV community build:

*Download latest stable or pre-release (to be used at own risk) Android TV OS image from [https://github.com/ayufan-rock64/android-7.1/releases ayufan's github]. The image you wish to download is the one '''with update suffix'''. You need to '''rename the downloaded image to update.img'''.
*Download the [http://www.haoyuelectronics.com/service/RK3066/tools/linux/Linux_Upgrade_Tool_v1.2.tar.gz Linux Upgrade Tool] to your Linux PC and unarchived it.
*Extract the archived update Android OS image somewhere where you will remember its path
*Hold down the recovery button on the board
*Insert one end of the A-to-A cable into your Mac OS or Linux PC and the other into your Rock64 OTG USB port (top)
*Inset the power cord into the Rock64
*In terminal, navigate to where you extracted Rockchip Update Tool and issue the following command substituting the correct path for where the Android Update OS Image is located: ''sudo ./upgrade_tool uf /path/to/update.img''
*Wait as the utility installs Android to eMMC on your Rock64.
*Remove the USB A-to-A cable, power off your board and power it on again to boot into eMMC.

== Flashing u-boot to SPI Flash ==

Some of PINE64 devices, such as the Rock64 and SOPine, are equipped with SPI Flash. This allows users to flash u-boot onto the SPI and boot from an external USB 2.0 or USB 3.0 SSD/HDD/thumb-drive, thereby forgoing using eMMC or an microSD card.

To find out more about which images can used in conjunction for SPI booting please see [https://github.com/ayufan-rock64/ ayufan's github].

Writing u-boot to SPI Flash can be achieved in two ways:

=== Using a Stand-Alone Image to Write u-boot to SPI ===
This may be the simplest method of flashing u-boot to SPI. Download a dedicated image labelled '''u-boot-flash-spi.img.xz''' from [https://github.com/ayufan-rock64/linux-u-boot/releases ayufan's github] and flash it to a micro SD card, the same you would with any OS image (to learn how to flash OS images to micro SD please following steps outlined in [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Section 3].

'''Having flashed the image follow these steps''':

*Insert the SD into the ROCK64
*Remove all other peripherals from the board
*'''Make sure that the eMMC module is disconnected from the board'''
*Apply power to the ROCK64
*Wait (few seconds) until the the LEDs on the board will blink continually
*Power off the board.

The board is now ready to boot from USB 2.0/3.0 storage.

=== Using a Script on Linux OS Images ===
Most of recent (newer than 0.6.9) Linux OS images contain a script called '''rock64_write_spi_flash.sh''', which is found in ''/usr/local/sbin'' directory. To run the script you will first need to flash a Linux OS image to a micro SD card (to learn how to flash OS images to micro SD please following steps outlined in [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Section 3]). Before proceeding '''make sure that the eMMC module is disconnected''' from the board. Once you have booted into Linux on your PINE64 device all you have to do is run the aforementioned script using this command:

''sudo ./rock64_write_spi_flash.sh''

Once the script finishes its operation, power off your board and remove the micro SD card.
The board is now ready to boot from USB 2.0/3.0 storage.

=== Erasing and Rewriting SPI ===
There are two ways of removing u-boot from SPI. You can either download '''u-boot-flash-spi.img.xz''' from [https://github.com/ayufan-rock64/linux-u-boot/releases ayufan's github] or use a script found on Linux OS images titled:'''rock64_erase_spi_flash.sh'''. Follow the instructions in the previous sub-sections for the chosen method of removing u-boot from SPI; the instructions are are identical, as the process of erasing u-boot is the exact opposite of flashing it.

'''N.B. You can also erase SPI manually".
To do so, you need to download mtd-utils. on Debian or Ubuntu follow these instructions:

''sudo apt-get install mtd-utils''
''sudo flash_eraseall /dev/mtd0''

=== Booting an OS image from USB 2.0/3.0 Storage ===
To boot and OS image from USB 2.0/3.0 Storage such as a SSD/HDD or a thumbdrive you first need to have u-boot written to your SPI flash. Please follow the instructions in the previous sub-sections to learn how to write u-boot to SPI on your PINE64 device.

Once you have u-boot on your SPI, the process off booting is very similar to booting from micro SD or eMMC.
*Download one of the supported OS images for your PINE64 device
*Flash the OS image to your USB 2.0/USB 3.0 storage device (to learn how to flash OS images please following steps outlined in [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Section 3] The instructions are identical for all types of storage, including USB 2.0/USB 3.0 HDDs and thumb-drives.)
*Insert the USB storage device with the flashed OS image into one of the USB ports on your PINE64 device
*Apply power

If you have followed all the steps correctly, the board should boot from your USB 2.0/3.0 storage device.

== Troubleshooting Your Device ==

There is a number of things that can prevent the PINE64 board from booting up properly. The most common culprits of a failed boot are (to find out more click [http://forum.pine64.org/showthread.php?tid=514 here]):

* Subpar or counterfeit microSD card
* Subpar Power Supply
* High resistance (thin) or a very long microUSB cable
* Failed imaging of the microSD card or eMMC module

Make sure to have the newest version of the OS image your are running. On Allwinner A64 devices running Linux you can update the kernel and uboot using scripts located in the following directory: /usr/local/sbin

* To navigate to the directory type (in terminal): ''cd /usr/local/sbin''
* You list all the available scripts by typing (in terminal): ''ls''
* To run the script required update script run the following command: ''sudo ./update_script.sh'' (substitute the relevant update script for update_script)

'''Troubleshooting Step by Step'''

Follow these steps to determine the cause of your problem:

* Check your PSU and microUSB cable ratings
* Download and image a base image of Linux
* Plug in power and Ethernet into your PINE64 device
* Watch Ethernet port LED activity
* Check your router for your device's IP
* Attempt to ssh into your device's from your computer

If your PSU and microUSB meet the criteria, and you have correctly followed the instructions to image your card and power on the board, but you are not seeing any LED activity and cannot ssh into your device then either the imaging process failed (possibly due to a subpar microSD) OR the PSU / microUSB cable is/are faulty.

If your PSU and microUSB meet the criteria, and you have correctly imaged the OS to your card and power on the board and your can ssh into your PINE A64(+) but get no video feed, then it's likely that the native resolution of your monitor/TV is not supported.

If neither of the above mentioned scenarios fits the problem you are facing, please consult this thread (thanks to Ghost for compiling the list): http://forum.pine64.org/showthread.php?tid=680

If you cannot find a solution to your problem you can submit a ticket at: https://support.pine64.org/

Getting started

2020-06-06T19:11:58Z

Oxoocoffee:

[[File:NOOB.png]]

== Setting Up Your device - What You’ll Need to Get Started ==

You will need the following to get started with using your PINE A64(+), SOPine/PINE A64-LTS, Pinebook or ROCK64 board:
* Windows / Linux PC or MAC with a SD Card Reader connected to the Internet.
* For PINE A64(+): Power Supply (PSU) and a micro usb cable. Please make sure to use a PSU rated at +5V @2A and a micro USB cable that is at least 26 AWG thick.
* For SOPine/PINE A64-LTS: Power Supply (PSU) with 3.5mm OD/1.5mm ID barrel DC Jack. Please make sure to use a PSU rated at +5V @2A.
* For Pinebook and ROCK64: Power Supply (PSU) with 3.5mm OD/1.5mm ID barrel DC Jack. Please make sure to use a PSU rated at +5V @3A.
* MicroSD card (8GB or higher capacity) rated 'class 10' or better.
* HDMI cable (unless you wish to run headless / without a monitor). On '''A64 Devices''' Android and Remix OS support 720p and 1080p, while Linux supports a [https://github.com/longsleep/sunxi-disp-tool#available-hdmi-output-names wider range of resolutions].
* Input device(s) such as: keyboard, mouse, remote, pointer, etc.

== A One-Step Solution to Flashing Your MicroSD Card ==
Please try our [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md PINE64 Installer] to easily select the PINE A64(+), SOPINE/PINE A64-LTS, Pinebook or ROCK64 OS of your choice and flash it to your MicroSD Card.

You can also flash an OS image manually; please follow the instructions below.

== Step-by-Step Instructions to Flashing MicroSD Cards ==

'''Caution!'''

Handle the Pine64 Single Board Computers' PCBs with care. Always hold bare boards by the edges and make sure to wear an anti-static wrist strap. Touching components on the front and back of the boards can result in an ESD discharge that may cause damage to the electronics. Avoid placing bare boards on materials such as carpets, plastics or other surfaces prone to electrostatic build-up.

'''Begin by imaging the OS of your choice'''

The process of flashing PINE64 OS images to micro SD on your Windows, Linux or OSX device is the same for all devices. You will require a quality microSD card (8GB or greater; class 10 or faster). There are many [http://forum.pine64.org/showthread.php?tid=681 substandard and counterfeit cards] in circulation and even reputable vendors may unknowingly sell counterfeit microSD cards. Cards that do not meet the criteria outlined above are known to cause a variety of issues including, but not limited to, complete boot failure. There are ways of testing microSD cards prior to installing the operating system to make sure they are appropriate for use with your board. The main utility for checking microSD cards is [http://www.softpedia.com/get/System/System-Miscellaneous/H2testw.shtml#download H2testw 1.4]; yet another alternative is [https://github.com/AltraMayor/f3/archive/v6.0.zip F3].

Please refer to the relevant section below for instructions on how to image your microSD card:
* [[#Imaging microSD on Windows 7/8/8.1/10|Imaging microSD on Windows 7/8/8.1/10]]
* [[#Imaging microSD on Apple OSX|Imaging microSD on Apple OSX]]
* [[#Imaging microSD on Linux|Imaging microSD on Linux]]

Having successfully imaged your microSD card, insert it into the microSD slot.

'''Plug in the HDMI Cable, Ethernet Cable and Peripherals to your PINE64 SBC'''

Unless you are planning on running your board headless (without a monitor / as a server) you should plug in all necessary peripherals, including the HDMI and Ethernet cable, prior to powering ON the board. Do note, depending on which OS image you are using, some peripherals may or may not work.

'''Apply Power to Your Board'''

Once you have imaged your microSD and plugged everything in, you are ready to apply power to the PIN64 Single Board Computer. You'll need a good quality 5 Volt, 2 Amp PSU. Using a good quality PSU is very important as failing to meet the required specifications may prevent the board from booting correctly. A marginally higher PSU Voltage is acceptable (for instance, 5.1 volts - due to the nature of the micro usb connection, a 5.1v supply can help protect slightly against voltage drops which can cause undesirable results). However, a significantly higher voltage of 7 Volts or more will damage the PINE64 Single Board Computer and may render it inoperative.

For PINE A64(+) board, if you are using a separate micro USB cable with your PSU, make sure that the cable has a low resistance rating. Cables with high resistance will cause improper function and the unit may not boot at all or only partially. The thicker the internal cabling, the better [http://voyager8.blogspot.co.uk/2013/04/how-to-choose-good-usb-data-and.html i.e. AWG (American Wire Gauge) 20 is better than AWG 28]. In General, '''power-only microUSB''' cables come with red colour USB header.

Having completed the steps outlined above the PINE64 SIngle Board Computer will begin to boot. The onboard power-on LEDs will come on and Ethernet port LEDs will start to blink if you have an Ethenet cable plugged in.

----

=== Imaging microSD on Windows 7/8/8.1/10 ===

You will need the following utilities to get started with imaging the OS of your choice onto your microSD card:
* A compression utility (used to unarchive the OS image). We recommend you use [http://www.7-zip.org/download.html 7zip].
* A disk image utility (used to flash the .img to your SD card). We recommend you use either the [https://etcher.io/ Etcher] or [https://sourceforge.net/projects/win32diskimager/ Win32Imager] utility.

'''Optional for Allwinner A64 SoC based boards'''
* Phoenix Card image utility (used ONLY for phoenix card images). You can download it from [https://drive.google.com/file/d/0B0cEs0lxTtL3VmstaEFfbmU1NFk/view?usp=sharing here].

'''Downloading and extracting OS image(s)'''

You can find OS images for the respective devices in the [http://wiki.pine64.org/index.php/Main_Page device section] on the main page.
Images designated ‘DD’ need to be flashed using Etcher or Win32imager, whilst images labelled ‘Phoenix Card Image’ require the Phoenix Card utility.

Having downloaded the required OS image proceed to use 7zip to unarchive it by right-clicking the archive, and selecting ‘Extract All’. Upon completion, note the destination of where the .img file was extracted (‘Downloads’ folder by default). Once the process has completed, you can proceed to imaging the .img file.

'''Imaging the microSD card (DD)'''

* Insert your microSD card into your laptop/USB card reader. You may require a SD → microSD converter, as most laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer, make sure to take note of the drive it has been assigned (the drive is assigned a letter, e.g. ‘F:’). You will need to remember the ‘letter’ it has been assigned when imaging the OS.

* Launch Win32diskImager.exe or etcher.exe. You will be presented with a field titled ‘path’ and a drop down menu labeled ‘device’. Click the ‘path’, navigate to and select the OS image you extracted from the archive earlier. Next, from the drop-down menu select the drive your microSD has been assigned. '''N.B.''' Pay close attention to the selected drive (remember your letter) – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Having chosen the desired OS image and the correct driver press ‘write’. Once the image has been written to your microSD card you will receive a pop-up notification. Be sure to close the application and to eject/remove your SD card safely from Windows.

'''Imaging using Phoenix Card (applicable only to Allwinner A64 SoC based boards)'''

On Windows, you can also use Phoenix Card (for detailed instructions click [[PhoenixCard|here]]). The Phoenix Card utility works ONLY with images designated as ‘Phoenix Card’ in the downloads section. To use Phoenix Card follow these steps:

* Insert your microSD card into your laptop/USB card reader. You may require a SD → microSD converter, as most laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer, make sure to take note of the drive it has been assigned (the drive is assigned a letter, e.g. ‘F:’). You will need to remember the ‘letter’ it has been assigned when imaging the OS.

* Launch phoenixcard.exe. You will be presented with a ‘disk’ drop-down menu and a field denoted as ‘.img File’. Click on ‘.img File’ and navigate to and select the OS image have downloaded and unarchived. Next, make sure to select the disk that your microSD card has been assigned. '''N.B.''' Pay close attention to the selected drive (remember your letter) – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Make sure to select ‘Startup!’ from the ‘Write mode’ window and click Burn. Once the image has been written to your microSD card you will receive a confirmation in the ‘option’ window. Be sure to close the application and to eject/remove your SD card safely from Windows.

----

=== Imaging microSD on Apple OSX ===

You will need the following utilities to get started with imaging the OS of your choice onto your microSD card:
* A compression Utility (used to unarchive the OS image). We recommend you use [http://www.7-zip.org/download.html 7Zip].
* A disk image utility (used to flash the .img to your SD card in GUI). We recommend you use [http://mac.softpedia.com/get/Utilities/ApplePi-Baker.shtml#download ApplePi Baker] or [https://etcher.io/ Etcher].

'''N.B.''' Phoenix Card utility and images are NOT available on Apple OSX.

'''Downloading and extracting OS image(s)'''

You can find OS images for the respective devices in the [http://wiki.pine64.org/index.php/Main_Page device section] on the main page. On OSX you can only use images designated as ‘DD’.

Having downloaded the required OS image proceed to use 7zip to unarchive it by double clicking the archive, and selecting ‘Extract All’. Upon completion, note the destination where the .img file was extracted (‘Downloads’ folder by default). Once the process has completed, you can proceed to imaging the .img file.

'''Imaging the microSD card (GUI)'''

* Insert your microSD card into your Mac laptop/USB card reader. You may require a SD → microSD converter, as Apple’s laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer it should appear in Finder / on your desktop.

* Launch Apple-Pi Baker or the etcher utility. Upon startup the application it will ask for your password. When the application launches you will be presented with a field titled ‘IMG file’ and a path of the mounted microSD card (it will look something like this: ‘/dev/diskX 32.0Gb SD card’). Click the ‘IMG file’ button, navigate to and select the OS image you extracted from the archive earlier. Next, select the microSD from the window. '''N.B.''' Pay close attention to the selected drive – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Having chosen the desired OS image and the correct driver press ‘Restore Backup’. Once the image has been written to your microSD card you will receive a pop-up notification. Be sure to close the application and to eject/remove your SD card safely from your Mac.

'''Imaging from Terminal'''

'''N.B.''' If you are not comfortable using the terminal, please use the GUI method outlined above instead.

* Insert your microSD card into your Mac laptop/USB card reader. You may require a SD → microSD converter, as Apple’s laptops and desktops only feature a full-size SD card reader. Once the microSD card is plugged into your computer it should appear in Finder / on your desktop.

* Open up your terminal and navigate to the directory where you unarchived your OS image.

* Before you start writing to the card, you will have to identify your microSD card. Type: diskutil list and note the output. The disk number should match the size of your SD card and will likely be using ‘Fdisk_partition_scheme’. Having identified the disk number execute the following commands (substitute diskX for your disk and name of image for pine64-image-name.img):

''diskutil unmountDisk /dev/diskX
sudo dd if=pine64-image-name.img of=/dev/disk2 bs=1M''

* Wait patiently for the process to complete. Be sure to eject/remove your SD card safely from your Mac.

----

=== Imaging microSD on Linux ===

You will need the following utilities to get started with imaging the OS of your choice onto your microSD card:
* A compression Utility (used to unarchive the OS image). We recommend you use [http://www.7-zip.org/download.html 7Zip].
* A disk image utility (used to flash the .img to your SD card in GUI). We recommend you use [https://etcher.io/ Etcher] or the [https://git.gnome.org/browse/gnome-disk-utility/ GUI Disks utility] that ships with most popular distros.

'''N.B.''' Phoenix Card utility and images are NOT available on Linux.

'''Downloading and extracting OS image(s)'''

You can find OS images for the respective devices in the [http://wiki.pine64.org/index.php/Main_Page device section] on the main page. On Linux you can only use images designated as ‘DD’.

Having downloaded the required OS image proceed to use 7zip to unarchive it by double clicking the archive, and selecting ‘Extract All’. Upon completion, note the destination where the .img file was extracted (‘Downloads’ folder by default). Once the process has completed, you can proceed to imaging the .img file.

'''Imaging the microSD card (GUI)'''

* Insert your microSD card into your Linux laptop/USB card reader. Once the microSD card is plugged into your computer it should appear in your File Manager / on your desktop.

* Launch Disks or the etcher utility (This tutorial outlines how to use Disks, if you wish to learn how to use Etcher please visit [https://etcher.io/ their website]).

* Upon launching Disks, you will be presented with all volumes visible to your computer. As a rule of thumb, your microSD card should be found at the bottom of listed volumes. Verify this by checking the size and mounting of the microSD card. '''N.B.''' Pay close attention to the selected drive – the imaging process will format the selected drive. If you choose the wrong drive all your data will be lost.

* Having selected your microSD card, click the cog menu in top right corner and choose the ‘Restore Disk Image’ option from the drop-down list. Navigate to and select the OS image you extracted from the archive earlier. Once you select it, you will be asked to enter your password and to confirm writing to the chosen volume (microSD card).

* You will be given a predicted time, writing-speed and completion percentage. Once the image has been written to your microSD card you will receive a pop-up notification. Be sure to close the application and to eject/remove your SD card safely from your computer.

'''Imaging from Terminal'''

'''N.B.''' If you are not comfortable using the terminal, please use the GUI method outlined above instead.

* Insert your microSD card into your Linux laptop/USB card reader. Once the microSD card is plugged into your computer it should appear in Finder / on your desktop.
* Open up your terminal and navigate to the directory where you unarchived your OS image. e.g. <code> cd Download</code>
* Before you start writing to the card, you will have to identify your microSD card.

* Type: <code>lsblk</code> and pay attention to the listed disks. Disks will appear as ''/dev/mmcblk0 /dev/mmcblk1'' etc.
* '''Hint''': the drive you currently have booted from has the <code>/</code> at the end of the line. This is the wrong drive. Look at the drive that matches your microSD card’s size.
* Having located the microSD card use the following command to flash the .img of choice to the microSD card (/dev/sdb used as example): <code>sudo unmount /dev/mmcblk0</code>
* Now you are ready to write the image to the microSD card using this command: (replace the pine.img file with your image and mmcblkX with the correct device for the microSD card)

<code>sudo dd if=pine.img of=/dev/mmcblkX bs=1M status=progress conv=fsync</code>

* Wait patiently for the process to complete.
* use the command <code>sync</code> to ensure everything is written to the microSD card.
* The card is ready to boot

(sometimes this process fails and your microSD card can't boot, one way of fixing this is just to repeat the same thing, you can also try a different microSD card)

== Instructions to Flashing eMMC Modules ==

All PINE64 devices - with the '''notable exception of the original Pine A64(+) SBC''' - support eMMC modules as an alternative boot and storage solution to micro SD cards.
An eMMC module can be purchased for your device(s) from the [https://www.pine64.org/?post_type=product PINE64 store]. The only PINE64 device that ships with an eMMC module by default is the Pinebook.

The available modules come in three different capacities: 16Gb, 32Gb, 64Gb and 128Gb

There are a few ways to flash eMMC modules with the desired OS image. The following sections are a summary of the processes involved in flashing the OS image of your choice to the eMMC module.

----

=== Flashing Using Pine64 Installer (Micro SD-to-eMMC) ===

This may be the simplest way to install an OS image to eMMC, however the selection of images that can be installed using this method is, at the time of writing, very limited.
To flash the OS image to your eMMC using this process you will need the following:

* An SD card of at least 8Gb capacity
* A Windows, Linux or Mac OS computer with the [https://github.com/pine64dev/PINE64-Installer/blob/master/README.md PINE64 installer] installed. The PINE64 Installer is available for all major platforms.
* A SD card reader
* Your PINE64 device with the eMMC module installed

'''The SD-to-eMMC Flashing Process'''

*Begin the process by launching the PINE64 Installer utility and clicking 'Choose an OS'. Next select your device from the drop-down menu. You will be presented with the various OS images available via the utility; you will notice that some of the OS images have '''SDCard to eMMC listed next to them in the brackets'''. Only images with this designation in the brackets will be able to help you flash the image of your choice to eMMC.

*Having selected an OS image put in your microSD card into your SD cardreader and follow the on-screen instructions. The process will flash the SD-to-eMMC installation image to your micro SD card. Once PINE64 Installer has completed the flashing process remove and micro SD card from your computer and place insert it into your PINE64 device.

*Connect a keyboard and HDMI display for the SD-to-eMMC installation process (does not apply to Pinebook). Make sure that both your eMMC module and micro SD card are inserted into your device and apply power to the unit. You will be provided with further instructions on the display as well as a progress bar of the eMMC installation process. Once the process is complete, power down your PINE64 device and remove the micro SD from its socket. You can now boot into your OS image of choice from the eMMC module.

----

=== Flashing Using the USB-to-eMMC Adaptor (Preferred Way) ===

A USB-to-eMMC adaptor is available from purchase from the [https://www.pine64.org/ PIN64 Store] making it easy to mount the eMMC module as a volume in your Windows, Mac OS or Linux computer. The eMMC can hence be flashed directly from your computer with any image similarly to a micro SD card.

'''This installation method works for all devices that support eMMC modules regardless of the chipset''' and it is therefore the preferred way of flashing OS images to eMMC. All available OS images for your device can be installed on the eMMC module this way.

*This process of flashing an OS image to eMMC is '''literally identical to imaging micro SD cards''', so please read [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Step-by-Step Instructions to Flashing Micro SD Cards] before you begin.

For this method you will need the following:

*A Windows, Linux or Mac OS computer
*A PINE64 eMMC module
*The PINE64 USB-to-eMMC adaptor

'''Flashing eMMC using the adaptor'''

*Insert the the eMMC module into the USB adaptor and plug it into your Windows, Linux or Mac OS computer. It should mount as a regular USB drive and show up in your file manager.
*If you are using Linux or Mac OS you can either use the dd terminal command or a GUI utility such as [https://etcher.io/ Etcher] to flash the chosen OS Image to eMMC.
*If you are using a Windows machine use [https://etcher.io/ Etcher] or [https://sourceforge.net/projects/win32diskimager/ Win32 Disk Imager] to flash the OS Image to the eMMC module.

Once the image has been flashed using your preferred method safely dismount the USB adaptor in your system and unplug it from your computer. Your eMMC is now ready to boot and can be inserted into the eMMC socket on your PINE64 device.

----

=== Flashing to eMMC from a SD Boot ===

Some of the available Linux images for Allwinner A64 devices recognise eMMC modules as mounted storage when the device is booted from a micro SD card. This is true for all recent releases of [https://github.com/ayufan-pine64/linux-build/releases ayufan's Linux images]. In result it is possible to flash an OS image to eMMC using the DD command in terminal or the Disks GUI utility included with the Mate desktop.

There are '''two ways''' in which an OS image can be flashed from within a micro SD boot:
*Via a script called Pine64_install_to_eMMC.sh found in ''/usr/local/sbin''. This script will install an Ubuntu Mate OS installation (identical to the on running on the SD) to the eMMC module. To execute the script navigate to its location in the terminal and type ''sudo ./Pine64_install_to_eMMC.sh''. Follow the instructions.

*By manually downloading and flashing a OS image for your device using DD or the Disk GUI. This way of flashing an OS image to the eMMC is identical to that used on a Linux computer (e.g. for flashing an OS image to a SD card). For more information on how the process works please see the detailed guide on [http://wiki.pine64.org/index.php/NOOB#Imaging_microSD_on_Linux imaging OS images to SD card on Linux].

For the latter of the two methods here is a summary of the process:
*Flash an OS image which recognises eMMC as mounted storage to a micro SD card. For details on how to flash a micro SD card see [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards section 3.0]
*Insert both the micro SD and eMMC module into your device and power it on.
*Once the PINE64 device boots from micro SD, open the web browser and download the desired OS image for your device.
*Once the OS image downloads check in terminal or in Disks utility the eMMC's mounting location.
*Use the DD command or Disks utility to flash the downloaded image to the eMMC module.
*Once the flashing process is completed power down your device and remove the micro SD card. You should now be able to power your device back up and it will boot the image flashed to the eMMC module.

----

=== Flashing to eMMC using FEL (Allwinner A64 Devices Only) ===

Under particular circumstances it may prove difficult to rely on a SD card to flash an OS image to an Allwinner A64 device. In such instances OS images can be directly flashed by means of entering into FEL mode. FEL is a low-level subroutine in the BootROM, and the process of enabling FEL differs from one device to another. To learn more about FEL please refer to the [http://linux-sunxi.org/FEL SUNXI Wiki section] dedicated to the subject.

The process of flashing via FEL is more complex than utilising a micro SD and is therefore '''better suited for proficient and advanced users'''.

For the process of flashing an image to the eMMC on a device in FEL mode you will need:
*A computer running Mac OS or Linux
*An OTG USB A-to-A cable

To enter FEL you will need to:
*On the Pinebook, power down the Pinebook and remove the PSU, unscrew the bottom of the case and press down the FEL button on the PCB (REF). Plug in the OTG USB A-to-A cord to your computer and the OTG USB port on the Pinebook (on the right facing an open case). Reinsert the PSU cord and press the power button with the FEL button pressed down. Release the FEL button after 3 seconds.
*On the Pine A64(+) power down the board and remove the micro SD card and power cord. Plug in the OTG USB A-to-A cord to your computer and the OTG USB port on the Pine A64 (+) and SoPine (top port). Power on the device and immediately after insert a micro SD card [https://app.box.com/s/s3m7rb5zfe0jkwqhaiy1zytqq3436fqs with FEL code].

You can check if your device entered FEL mode using ''lsusb'' command in terminal. It should be listed as a device on the USB Bus.

The next step is to mount your device so that your computer recognises the eMMC as mass storage (UMS). A script called boot-tools streamlining this process is available '''thanks to ayufan''' on [https://github.com/ayufan-pine64/boot-tools his github]. Follow his instructions and in terminal perform the following stepps:

*''git clone https://github.com/ayufan-pine64/boot-tools.git
*''cd boot-tools''
*''make pinebook_ums''
or
*''make pine64_ums''

Once your device mounts as UMS it will appear in your file manager. In CLI you can check if the storage is listed using ''fdisk -l''.

This process of flashing an OS image to eMMC with the device in FEL mode and mounted as UMS is '''literally identical to imaging micro SD cards''', so please read [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Step-by-Step Instructions to Flashing Micro SD Cards] and follow the procedure. You can use DD or Disks/ Disk Utility to flash the OS image directly to your device's eMMC.

Once the flashing process is completed, power down your device, remove the A-to-A USB OTG cable and after reapply power to boot your device from eMMC.

----

=== Flashing to eMMC using Rockchip Tools (Rock64 Only) ===

Rockchip has a different boot hierarchy to Allwinner's devices making it much more difficult to flash OS images using the micro SD-to-eMMC scheme used on A64. There are, however, flashing tools that make it possible to flash directly to eMMC on a Rock64 in loader and MarkROM modes.

To flash to the eMMC module using these tools you will need the following:
*A Windows, Mac OS or Linux computer
*An A-to-A USB cable
*The Rock64 board with the eMMC module inserted into the socket

'''Using Windows 7/8.1/10 '''
You will need to download the [https://github.com/rockchip-linux/tools/tree/master/windows DriverAssistant aka Rockchip driver] as well as the [https://github.com/rockchip-linux/tools/tree/master/windows AndroidTool_Release] used for flashing OS images. Having completed the downloads extract both archives.The Rockchip driver needs to be installed prior to using the AndroidTool utility.

Having installed the driver and flashing utility, follow these steps:
*Make sure that eMMC is inserted into the slot on the Rock64
*Place a jumper / short out the eMMC pins on the board (consult [http://files.pine64.org/doc/rock64/guide/ROCK64_Installing_Android_To_eMMC.pdf this document] for more details.
*Insert one end of the A-to-A cable into your Windows PC and the other into your Rock64 OTG USB port (top)
*Inset the power cord into the Rock64
*Start AndroidTool; make sure that it reports 'Found One Maskrom Device' (if it does not recognise your device, please repeat previous steps)
*Select either the latest Stock Android build or ayufan's Android TV build with the suffic -update. Download and the extract the chosen image.
*In AndroidTool press the firmware tab and navigate to where you extracted the OS image and select it.
*Press the upgrade tab. You will be prompted when the flashing process is completed.
*Remove the USB A-to-A cable, power off your board and power it on again to boot into eMMC.

'''Using Linux or Mac OS'''

*Make sure that eMMC is inserted into the slot on the Rock64
*Download latest stable or pre-release (to be used at own risk) Android TV OS image from [https://github.com/ayufan-rock64/android-7.1/releases ayufan's github]. The image you wish to download is the one '''without a suffix'''; without -update or -raw in the OS image title.
*In terminal, download rkflashtool following instructions on [https://github.com/ayufan-rock64/android-7.1/blob/master/README.md ayufan's github]
*Extract the folder containing partitions of the OS image and place the script listed on ayufan's github in the folder
*Hold down the recovery button on the board
*Insert one end of the A-to-A cable into your Mac OS or Linux PC and the other into your Rock64 OTG USB port (top)
*Inset the power cord into the Rock64
*Check that your device is in loader mode by typing in the terminal ''sudo rkflashtool n''. If rkflashtool doesn't detect the Rock64 please repeat last 3 steps
*In terminal navigate to where you extracted the Android folder containing the OS partitions and the script and type ''rkinstall''; this will install the community Android TV build to eMMC.
*Remove the USB A-to-A cable, power off your board and power it on again to boot into eMMC.

----

=== Flashing to eMMC Android 'Update' OS Images on Linux (Rock64 Only) ===

It is possible to flash Android 'update' images to the Rock64 eMMC using a Linux PC. This process requires a tool called [http://www.haoyuelectronics.com/service/RK3066/tools/linux/Linux_Upgrade_Tool_v1.2.tar.gz Linux Upgrade Tool] and the full documentation of its functions can be found [http://www.hotmcu.com/wiki/Flashing_Firmware_Image_Files_Using_The_Rockchip_Tool#Using_Linux_Upgrade_Tool_to_flash_update.img here]. Make sure that you download v1.2 or newer, as older tools do not support the RK3328 used on the Rock64.

To flash to the eMMC module using this method you will need the following:
*A Linux computer
*An A-to-A USB cable
*The Rock64 board with the eMMC module inserted into the socket

Start by downloading an Android '''update''' image for the Rock64. Both PINE64 and Ayufan provide such images for the board - and they are clearly designated as such on both this WiKi's download section and on ayufan's github. For the purpose of this example, I'll use the ayufan's ATV community build:

*Download latest stable or pre-release (to be used at own risk) Android TV OS image from [https://github.com/ayufan-rock64/android-7.1/releases ayufan's github]. The image you wish to download is the one '''with update suffix'''. You need to '''rename the downloaded image to update.img'''.
*Download the [http://www.haoyuelectronics.com/service/RK3066/tools/linux/Linux_Upgrade_Tool_v1.2.tar.gz Linux Upgrade Tool] to your Linux PC and unarchived it.
*Extract the archived update Android OS image somewhere where you will remember its path
*Hold down the recovery button on the board
*Insert one end of the A-to-A cable into your Mac OS or Linux PC and the other into your Rock64 OTG USB port (top)
*Inset the power cord into the Rock64
*In terminal, navigate to where you extracted Rockchip Update Tool and issue the following command substituting the correct path for where the Android Update OS Image is located: ''sudo ./upgrade_tool uf /path/to/update.img''
*Wait as the utility installs Android to eMMC on your Rock64.
*Remove the USB A-to-A cable, power off your board and power it on again to boot into eMMC.

== Flashing u-boot to SPI Flash ==

Some of PINE64 devices, such as the Rock64 and SOPine, are equipped with SPI Flash. This allows users to flash u-boot onto the SPI and boot from an external USB 2.0 or USB 3.0 SSD/HDD/thumb-drive, thereby forgoing using eMMC or an microSD card.

To find out more about which images can used in conjunction for SPI booting please see [https://github.com/ayufan-rock64/ ayufan's github].

Writing u-boot to SPI Flash can be achieved in two ways:

=== Using a Stand-Alone Image to Write u-boot to SPI ===
This may be the simplest method of flashing u-boot to SPI. Download a dedicated image labelled '''u-boot-flash-spi.img.xz''' from [https://github.com/ayufan-rock64/linux-u-boot/releases ayufan's github] and flash it to a micro SD card, the same you would with any OS image (to learn how to flash OS images to micro SD please following steps outlined in [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Section 3].

'''Having flashed the image follow these steps''':

*Insert the SD into the ROCK64
*Remove all other peripherals from the board
*'''Make sure that the eMMC module is disconnected from the board'''
*Apply power to the ROCK64
*Wait (few seconds) until the the LEDs on the board will blink continually
*Power off the board.

The board is now ready to boot from USB 2.0/3.0 storage.

=== Using a Script on Linux OS Images ===
Most of recent (newer than 0.6.9) Linux OS images contain a script called '''rock64_write_spi_flash.sh''', which is found in ''/usr/local/sbin'' directory. To run the script you will first need to flash a Linux OS image to a micro SD card (to learn how to flash OS images to micro SD please following steps outlined in [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Section 3]). Before proceeding '''make sure that the eMMC module is disconnected''' from the board. Once you have booted into Linux on your PINE64 device all you have to do is run the aforementioned script using this command:

''sudo ./rock64_write_spi_flash.sh''

Once the script finishes its operation, power off your board and remove the micro SD card.
The board is now ready to boot from USB 2.0/3.0 storage.

=== Erasing and Rewriting SPI ===
There are two ways of removing u-boot from SPI. You can either download '''u-boot-flash-spi.img.xz''' from [https://github.com/ayufan-rock64/linux-u-boot/releases ayufan's github] or use a script found on Linux OS images titled:'''rock64_erase_spi_flash.sh'''. Follow the instructions in the previous sub-sections for the chosen method of removing u-boot from SPI; the instructions are are identical, as the process of erasing u-boot is the exact opposite of flashing it.

'''N.B. You can also erase SPI manually".
To do so, you need to download mtd-utils. on Debian or Ubuntu follow these instructions:

''sudo apt-get install mtd-utils''
''sudo flash_eraseall /dev/mtd0''

=== Booting an OS image from USB 2.0/3.0 Storage ===
To boot and OS image from USB 2.0/3.0 Storage such as a SSD/HDD or a thumbdrive you first need to have u-boot written to your SPI flash. Please follow the instructions in the previous sub-sections to learn how to write u-boot to SPI on your PINE64 device.

Once you have u-boot on your SPI, the process off booting is very similar to booting from micro SD or eMMC.
*Download one of the supported OS images for your PINE64 device
*Flash the OS image to your USB 2.0/USB 3.0 storage device (to learn how to flash OS images please following steps outlined in [http://wiki.pine64.org/index.php/NOOB#Step-by-Step_Instructions_to_Flashing_MicroSD_Cards Section 3] The instructions are identical for all types of storage, including USB 2.0/USB 3.0 HDDs and thumb-drives.)
*Insert the USB storage device with the flashed OS image into one of the USB ports on your PINE64 device
*Apply power

If you have followed all the steps correctly, the board should boot from your USB 2.0/3.0 storage device.

== Troubleshooting Your Device ==

There is a number of things that can prevent the PINE64 board from booting up properly. The most common culprits of a failed boot are (to find out more click [http://forum.pine64.org/showthread.php?tid=514 here]):

* Subpar or counterfeit microSD card
* Subpar Power Supply
* High resistance (thin) or a very long microUSB cable
* Failed imaging of the microSD card or eMMC module

Make sure to have the newest version of the OS image your are running. On Allwinner A64 devices running Linux you can update the kernel and uboot using scripts located in the following directory: /usr/local/sbin

* To navigate to the directory type (in terminal): ''cd /usr/local/sbin''
* You list all the available scripts by typing (in terminal): ''ls''
* To run the script required update script run the following command: ''sudo ./update_script.sh'' (substitute the relevant update script for update_script)

'''Troubleshooting Step by Step'''

Follow these steps to determine the cause of your problem:

* Check your PSU and microUSB cable ratings
* Download and image a base image of Linux
* Plug in power and Ethernet into your PINE64 device
* Watch Ethernet port LED activity
* Check your router for your device's IP
* Attempt to ssh into your device's from your computer

If your PSU and microUSB meet the criteria, and you have correctly followed the instructions to image your card and power on the board, but you are not seeing any LED activity and cannot ssh into your device then either the imaging process failed (possibly due to a subpar microSD) OR the PSU / microUSB cable is/are faulty.

If your PSU and microUSB meet the criteria, and you have correctly imaged the OS to your card and power on the board and your can ssh into your PINE A64(+) but get no video feed, then it's likely that the native resolution of your monitor/TV is not supported.

If neither of the above mentioned scenarios fits the problem you are facing, please consult this thread (thanks to Ghost for compiling the list): http://forum.pine64.org/showthread.php?tid=680

If you cannot find a solution to your problem you can submit a ticket at: https://support.pine64.org/