Skip to content

Commit

Permalink
Corrections in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
x1y committed Oct 11, 2024
1 parent 55a1e27 commit ac8b376
Show file tree
Hide file tree
Showing 16 changed files with 47 additions and 28 deletions.
9 changes: 6 additions & 3 deletions content/documentation/Clusterboard/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ To install a cluster it is important to know the IP addresses of each module, so

Each module may be plugged into the Clusterboard individually or consecutively, which makes it easy to assign a hostname to each module separately. It is also possible to manually edit the hostname in the OS image of each module before the first boot.

**💡 TIP**\
{{< admonition type="tip" >}}
The board has no hotplug functionality, so make sure you only plug/unplug the modules while the power is disconnected from the clusterboard.
{{< /admonition >}}

**💡 TIP**\
{{< admonition type="tip" >}}
No management features are available on the switch ship, so there is no VLAN support.
{{< /admonition >}}

## Serial console

Expand All @@ -29,5 +31,6 @@ To boot use the serial console connect the pins to UART0 on the GPIO header and

The pinouts are available in [this forum thread](https://forum.pine64.org/showthread.php?tid=8058).

**💡 TIP**\
{{< admonition type="tip" >}}
Do not connect the GND connector until the power is on as it can provide power and prevent the board from booting.
{{< /admonition >}}
5 changes: 3 additions & 2 deletions content/documentation/General/Mainline_Hardware_Encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ This example converts an input MP4 file to an output MJPEG-inside-MKV file at JP

### VP8 Encoding

**💡 TIP**\
**Note:** This requires a draft [GStreamer merge request](https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3736) and the RFC kernel patchset applied.
{{< admonition type="tip" >}}
This requires a draft [GStreamer merge request](https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3736) and the RFC kernel patchset applied.
{{< /admonition >}}

This example converts an input MP4 file to an output VP8-inside-MKV file with a quantiser between 12 and 28, without any audio. The quantiser value goes from 0 (best quality, biggest filesize) to 63 (worst quality, smallest filesize).

Expand Down
15 changes: 10 additions & 5 deletions content/documentation/General/U-Boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ menu:
weight:
---

**💡 TIP**\
{{< admonition type="tip" >}}
It is helpful to have a debugging serial cable for this.
{{< /admonition >}}

## Building U-Boot manually

Expand All @@ -26,8 +27,9 @@ If you are using a different system such as Ubuntu, there are plenty of cross co

### Compilation

**💡 TIP**\
{{< admonition type="tip" >}}
This guide is written with the PinePhone in mind. On other devices you will need to set a different platform variable and likely use a different U-Boot source with patches oriented towards your device.
{{< /admonition >}}

Note by default these instructions utilize all of your computers cores to compile thanks to the `-j` and `$(nproc)` parameters. If you wish to only use one core to compile, or change the number of cores used for example to only two cores, then you can either completely remove the `-j$(nproc)` parameter from the make commands, or just take off `$(nproc)` and add the number of threads you want used in it’s place: `-j4`

Expand All @@ -47,8 +49,9 @@ After the ATF is compiled clone u-boot and copy the bl31.bin file into the u-boo
cp build/sun50i_a64/release/bl31.bin ../u-boot/
cd ..

**💡 TIP**\
{{< admonition type="tip" >}}
You cannot build [Crust](/documentation/PinePhone/Software/Crust) if you do not have the or1k musl toolchain installed. This toolchain is not usually available in distribution repositories and will have to be manually installed to the system. The following text will show a simple way to install the toolchain.
{{< /admonition >}}

Download the toolchain’s archive: https://musl.cc/or1k-linux-musl-cross.tgz

Expand All @@ -71,8 +74,9 @@ After you’ve completed that you can close out the terminal and reopen it and p
cp build/scp/scp.bin ../u-boot/
cd ..

**💡 TIP**\
{{< admonition type="tip" >}}
If you do not wish to have [Crust](/documentation/PinePhone/Software/Crust) in your U-Boot build, then you can skip exporting SCP
{{< /admonition >}}

cd u-boot/
git checkout crust
Expand All @@ -95,8 +99,9 @@ Once successfully compiled you can proceed to flash the device
sudo dd if=u-boot-sunxi-with-spl.bin of=/dev/[CHANGE THIS] bs=1024 seek=8
```

**💡 TIP**\
{{< admonition type="tip" >}}
If you are compiling U-Boot in order to overclock your DRAM you can check if it was successful by reading the values of /sys/kernel/debug/clk/clk_summary
{{< /admonition >}}

## p-boot multi-bootloader

Expand Down
10 changes: 5 additions & 5 deletions content/documentation/Introduction/Getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,9 @@ You will need the following utilities to get started with imaging the OS of your
* A compression utility (used to unarchive the OS image). You may use [Keka](https://www.keka.io/en/).
* A disk image utility (used to flash the .img to your SD card in GUI). You may use [ApplePi Baker v2](https://www.tweaking4all.com/software/macosx-software/applepi-baker-v2/#DownloadApplePiBaker) or [Etcher](https://etcher.io/).

**💡 TIP**\
{{< admonition type="tip" >}}
Phoenix Card utility and images are NOT available on macOS.
{{< /admonition >}}

**Downloading and extracting OS image(s), insert the SD card**

Expand Down Expand Up @@ -152,8 +153,9 @@ You will need the following utilities to get started with imaging the OS of your
* A compression Utility (used to unarchive the OS image). We recommend you use [Ark](https://apps.kde.org/en/ark).
* A disk image utility (used to flash the .img to your SD card in GUI). We recommend you use [Etcher](https://etcher.io/) or the [GUI Disks utility](https://git.gnome.org/browse/gnome-disk-utility/) that ships with most popular distributions.

**💡 TIP**\
{{< admonition type="tip" >}}
Phoenix Card utility and images are NOT available on Linux.
{{< /admonition >}}

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

Expand Down Expand Up @@ -393,9 +395,7 @@ The board is now ready to boot from USB 2.0/3.0 storage.

There are two ways of removing u-boot from SPI. You can either download **u-boot-flash-spi.img.xz** from [ayufan’s github](https://github.com/ayufan-rock64/linux-u-boot/releases) 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.

**💡 TIP**\
You can also erase SPI manually.
To do so, you need to download mtd-utils. on Debian or Ubuntu follow these instructions:
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`

Expand Down
5 changes: 3 additions & 2 deletions content/documentation/Introduction/How_to_contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ By contributing code, for example as documented in the following project pages (

Many community projects and developers are working on the software on their free time. Donating to community projects and developers is a great way to support these projects and developers developing the software for the devices. The following list is an exemplary selection to which projects and developers can be donated to (in alphabetical order):

**💡 TIP**\
The following list is not a comprehensive list and solely a selection of different community projects and developers, which can be supported. Any FOSS development effort is valuable and should be rewarded, please support your favorite developer(s) or project(s) even if not mentioned on the list Your name or project not on the list?
{{< admonition type="tip" >}}
The following list is not a comprehensive list and solely a selection of different community projects and developers, which can be supported. Any FOSS development effort is valuable and should be rewarded, please support your favorite developer(s) or project(s) even if not mentioned on the list Your name or project not on the list?
{{< /admonition >}}

### Community projects

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ menu:

The mainboard can be replaced if it is faulty. The replacement board does not have an operating system pre-installed, to test if everything is working after swapping the mainboard a flashed microSD card is required.

**💡 TIP**\
{{< admonition type="tip" >}}
Replacement boards come with an empty eMMC, which means that trying to boot from them looks like the board is faulty (no LEDs, no screen, no reaction of the phone). Please boot an operating System from a microSD card.
{{< /admonition >}}

Prior to replacing your PinePhone’s mainboard please read the steps outlined in bullet points below and watch the attached video.

Expand Down
3 changes: 2 additions & 1 deletion content/documentation/PinePhone/Modem/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,9 @@ The custom firmware can be flashed using [fwupd](https://wiki.postmarketos.org/w

### Stock firmware

**💡 TIP**\
{{< admonition type="tip" >}}
The following instructions are directed towards professional users. It is highly recommend to make sure the update process is not interrupted to prevent the modem from bricking.
{{< /admonition >}}

The stock modem firmware can be updated to a newer version if it is outdated. The firmware version can be checked using the following AT command (at the example of `atinout`, alternatively `minicom` can be used to communicate with the modem too):

Expand Down
3 changes: 2 additions & 1 deletion content/documentation/PinePhone_Pro/Modem.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,9 @@ The custom firmware can be flashed using [fwupd](https://wiki.postmarketos.org/w

### Stock firmware

**💡 TIP**\
{{< admonition type="tip" >}}
The following instructions are directed towards professional users. It is highly recommend to make sure the update process is not interrupted to prevent the modem from bricking.
{{< /admonition >}}

The stock modem firmware can be updated to a newer version if it is outdated. The firmware version can be checked using the following AT command (at the example of `atinout`, alternatively `minicom` can be used to communicate with the modem too):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ In the factory test image, navigate to setting (gear icon) > at the very bottom

Please note: It is recommended to charge the device to at least 50% before proceeding with wiping the eMMC.

**💡 TIP**\
{{< admonition type="tip" >}}
Note: You may have gotten a Chinese factory image; in the settings menu you can change the language to English by selecting the gray info icon (系统, one from bottom), then the first option (语言..), and again the first option (also 语言), then press +, English and drag it to the top of the list).
{{< /admonition >}}

Connect the phone to your computer and check `adb devices` in the terminal. The phone should be registered as attached. If the device doesn’t show you may want to try a different port or cable. Then enter `adb shell` followed by `su` to gain root access. At this point you can erase the eMMC installation:

Expand Down
2 changes: 1 addition & 1 deletion content/documentation/PinePhone_Pro/Software/Boot_order.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ The RE button disables the SPI and the eMMC at the hardware level while the butt

## Boot from microSD card permanently

The bootloader (such as _U-Boot_) resides in the free space in front of the first partition. Wiping the bootloader from the eMMC to make the PinePhone Pro boot from microSD card can be done using `sudo dd if&#61;/dev/zero of&#61;/dev/mmcblk2 seek&#61;64 count&#61;400 conv&#61;fsync`. Formatting the drive or deleting the partition table is not sufficient to wipe the bootloader.
The bootloader (such as _U-Boot_) resides in the free space in front of the first partition. Wiping the bootloader from the eMMC to make the PinePhone Pro boot from microSD card can be done using `sudo dd if=/dev/zero of=/dev/mmcblk2 seek=64 count=400 conv=fsync`. Formatting the drive or deleting the partition table is not sufficient to wipe the bootloader.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following table lists the feature functionality status of the unaltered pre-
* Telegram: https://t.me/pinephone

{{< admonition type="note" >}}
The software is *written by the community*, any contributions towards the community projects are greatly appreciated! Please see "link:/documentation/Introduction/How_to_contribute[How to Contribute]" to learn about how to contribute to the software projects and "link:/documentation/Introduction/Where_to_report_bugs[Where to Report Bugs]" to learn about where to report bugs.
The software is *written by the community*, any contributions towards the community projects are greatly appreciated! Please see "[How to Contribute](/documentation/Introduction/How_to_contribute)" to learn about how to contribute to the software projects and "[Where to Report Bugs](/documentation/Introduction/Where_to_report_bugs)" to learn about where to report bugs.
{{< /admonition >}}

[cols="2,2,1,1,4"]
Expand Down
3 changes: 2 additions & 1 deletion content/documentation/Pinebook_Pro/Features/Webcam.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ menu:
weight:
---

**💡 TIP**\
{{< admonition type="tip" >}}
You can use Cheese to test the Camera functionality
{{< /admonition >}}

Streaming video resolutions supported, (uncompressed):

Expand Down
3 changes: 2 additions & 1 deletion content/documentation/Pinebook_Pro/Keyboard/Assembly.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ Older style scissor switches allowed you to just pull the keycap straight off th

Keys can be relatively safely removed (however the mechanism can easily be damaged by someone who doesn’t know what they’re doing) when the keyboard assembly has been removed from the shell, however with the shell in place it blocks movement of the keys that is required to unhook the mechanism from the metal backplate.

**💡 TIP**\
{{< admonition type="tip" >}}
The keys might be removable without taking the keyboard out of the frame, this needs more research
{{< /admonition >}}

To remove a key, first push it all the way in, slide it upwards slightly, and lift the top half of the key, this should dislodge the upper half of the scissor mechanism, this step can be tricky, the keys were designed to be assembled once and never removed again.

Expand Down
3 changes: 2 additions & 1 deletion content/documentation/Pinecil/Firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ This article is about updating/flashing the [Pinecil](/documentation/Pinecil) fi

## Overview

**💡 TIP**\
{{< admonition type="tip" >}}
Pinecil is designed to use **only 1 power port** at any time. Only the USB-C cable should be plugged in during firmware updates. Never attempt to use both rear ports at the same time or the PC and Pinecil will be damaged.
{{< /admonition >}}

{{< figure src="/documentation/images/Pinecil-V1andV2.png" title="right" width="400" >}}

Expand Down
3 changes: 2 additions & 1 deletion content/documentation/Pinecil/Tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ This article is about the available tips for the [Pinecil](/documentation/Pineci

## Pinecil Tips

**💡 TIP**\
{{< admonition type="tip" >}}
Pay attention to the length! Pine Store sells two different lengths of tips.
{{< /admonition >}}

### What kind of tips work?

Expand Down
3 changes: 2 additions & 1 deletion content/documentation/Pinecil/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ menu:

**Prep Tasks**

**💡 TIP**\
{{< admonition type="tip" >}}
Clean new cartridges/tips with isopropyl alcohol (IPA) to remove factory residue before installing (even if it looks clean). If you have no IPA, at least try a paper towel, especially clean the white end with the two silver electric contacts (do not use water; it could get into the seam line on the white end). This resolves issues with jumping temperatures or random no-tip symbol from poor electric contact.
{{< /admonition >}}

Do not try to bend the two [internal contacts](https://pine64.com/product/pinecil-copper-clips/), they are made of a thin stiff spring metal and could break (not soft copper), but you could wipe them with IPA (including the small PCB pad below the contacts).

Expand Down

0 comments on commit ac8b376

Please sign in to comment.