PINE64 - User contributions [en]

PineNote Development/TODOs

2022-12-22T17:31:04Z

Hmpthcs: /* Trying to fix bluetooth */

{{Template:Under construction}}

[[PineNote|Back to PineNote main page]]

= Status =

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

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

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

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

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

! | Accessory compatibility, spare parts

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

! | Software notes

| <code>Firefox</code>
| colspan="2" style="background:LightYellow; text-align:center;" | GPU Rendering Possible
| Requires patched mesa and <pre>MOZ_ENABLE_WAYLAND=1</pre>. [https://wiki.pine64.org/wiki/PineNote_Development/Apps#Firefox See here.]
|-
|}

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

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

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

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

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

== Open questions that would be helpful during development ==
# How do we pin packages so Mesa isn't updated when we update using our package manger?

= Documentation TODOs =
{{info|These are things we know how to do, but they just haven't been documented in the wiki yet. If you know how to do one of these things, please make a page for it. If you aren't sure where to put it or just don't feel like doing it, please just message @aarondabomb on matrix and I'll be happy to document it.}}

=== Pin Mesa Packages so they don't update when we upgrade other packages ===
Should be super simple, I just don't know how. If you know, it would be helpful for you to add that information near step 5 [https://wiki.pine64.org/wiki/PineNote_Development/Building_Kernel#Steps_to_build here].
=== Control the backlight? ===
=== Building alacritty correctly ===
=== Force a screen refresh? ===
Maximilian mentioned how to do this, but I don't know enough to know what it means XD see conversation here: https://matrix.to/#/!QtTzSRYMuozjbOQkzJ:matrix.org/$tfumBpnP2UPouNpaeFrggR40ZkrD_pHAtJdQmQvzL-o?via=matrix.org&via=kde.org&via=tchncs.de

= Trying to fix bluetooth =
I tried to add latency [https://askubuntu.com/questions/475987/a2dp-on-pulseaudio-terrible-choppy-skipping-audio as described here], but to no avail. I noticed the best performance with SBC codec, but still not usable.

==== Preliminary fix for stuttering bluetooth audio: ====
Following a fix used for the Quartz Model A (which uses the same SoC as the Pinenote), we can modify the device tree prior to building the kernel to try to mitigate poor bluetooth audio streaming. (reference: see https://lore.kernel.org/linux-arm-kernel/20220926055435.31284-1-leo@nabam.net/T/)

===== Steps: =====

* Open arch/arm64/boot/dts/rockchip/rk3566-pinenote.dtsi
* Go to line 939, "bluetooth", under the "uart1" section
* Edit the two lines that read "device-wake-gpios" and "host-wake-gpios"; you want them to read "device-wakeup-gpios" and "host-wakeup-gpios" respectively
* Add the following line to the end of the bluetooth section (under the vddio-supply line in my .dtsi): "max-speed = <3000000>;"
* Count your zeros, don't forget your punctuation..

===== Caveats: =====

This will improve BT audio quality at least when using the AAC codec. In my experience, the quality is more than acceptable, but there are still issues apparent: occasional isolated stutters even on AAC; prohibitively frequent stutters on SBC-XQ remain. Fully resolving BT audio issues might require further changes similar to the one described above, or may alternatively be a matter of audio software settings (e.g., process priority, audio server buffer settings). Investigation ongoing..

PineNote Development/Building Kernel

2022-12-22T17:27:01Z

Hmpthcs: /* Autoconnect to your Bluetooth devices */

= Building the Kernel =

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

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

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

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

=== A small warning ===

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

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

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

== What you should have already done ==

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

== What do you need to know? ==

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

== Steps to build ==

<ol>
<li> Clone Maximilian's scripts: </li>
<pre> $ git clone https://github.com/m-weigand/mw_pinenote_misc.git </pre>
<li> Make a separate directory for patching the kernel. Then run Maximilian's <code>clone_and_prepare_git.sh</code>. This will clone smaeul's kernel and a number of patches. Read the script to see which patches it is using. Feel free to open the patches too -- it's helpful to get a slim idea of what's going on, if only looking at the commit messages in them: </li>
<pre>
$ cd ../
$ sh mw_pinenote_misc/custom_kernel/clone_and_prepare_git.sh
</pre>
<li> Compile the kernel: </li>
<pre> $ sh ./mw_pinenote_misc/custom_kernel/compile.sh </pre>
<li> Next we want to perform the work captured in <code>install_to_pn.sh</code>, but the work may vary slightly from person to person. For example, I believe Maximilian is running Debian Sid, and I am running Manjaro -- because of this, and personal preference, some of our files live at different places. As long as you put them somewhere and configure your <code>extlinux.conf</code> to point at it, things will be okay. Looking at <code>install_to_pn.sh</code>, we can see that there are three pieces to installing the kernel: the kernel image (called <code>Image</code>), the device tree (<code>rk3566-pinenote-v1.2.dtb</code>), and the modules. All of these files have been compiled and placed into the <code>linux/pack</code> folder. The easiest way to send these over is by using scp or rsync -- read the script and decide how you would like to get your files in the correct location. You may need to install rsync on your PineNote if it doesn't already have it.
<ol><li>If it helps, I installed my dtb like this: <code>$ scp rk3566-pinenote-v1.2.dtb root@pinenote:/boot/dtbs/rockchip/</code></li>
<li>After installing the dtb as above, I updated my <code>/boot/extlinux/extlinux.conf</code> to point to this new file (previously, my dtb did not have the <code>-v1.2</code> on the end).</li>
</li>
<li> (Perhaps not necessary?) The last step is to generate a new initrd image. (If you're like me and don't know what initrd is, the [https://en.wikipedia.org/wiki/Initial_ramdisk wiki] is very enlightening.) This is done on the PineNote itself. Send Maximilian's installation script over and run it. Then place the generated image (from the last step of the shell script) into your boot partition and update <code>extlinux.conf</code> if needed to point at this new file.
<pre>
$ scp initrd/gen_uboot_image.sh root@pinenote:/root # Do this part on local to put script on PN
$ ssh root@pinenote # Or use UART, the dongle + picocom, and change to root
$ cd /root
$ ./gen_uboot_image.sh
$ mv initrd.img /boot/initrd.img
$ vim /boot/extlinux/extlinux.conf # Update this to reference this new initrd image
</pre>
<li> At this point your kernel is in place! However, there are a few more steps you may need to complete to ensure the display and networking continue to work:
<ol>
<li>For display, you may need to change <code>/lib/firmware/waveform.bin</code> to <code>/lib/firmware/rockchip/ebc.wbf</code> (TODO is this a difference between PG and smaeul's kernel? or a patch?)</li>
<li>For networking (and I imagine more as well), you may need to change <code>/lib/firmware/pinenote.bin</code> to <code>/lib/firmware/pinenote-v1.2.bin</code></li>
</ol>
</li>
<li> This part technically isn't kernel specific, but we need to install a patched version of Mesa. If you are running an Arch based system, you're in luck! occam_razor provides prebuilt patched packages (say that 5 times fast) [https://github.com/0cc4m/pinenote-misc/releases here]. Simply extract these files, send them to PN, and install them using the package manager. You can also patch it yourself by looking at Maximilian's [https://github.com/m-weigand/mw_pinenote_misc/blob/main/compile_mesa.sh compile_mesa.sh]. {{info|If you frequently update your system with something `pacman -Syu`, you will end up updating these packages and losing the patches. Add this line to your <code>/etc/pacman.conf</code> to prevent them from being updated: <pre>IgnorePkg = libva-mesa-driver mesa mesa-debug mesa-vdpau opencl-mesa vulkan-mesa-layers vulkan-broadcom vulkan-panfrost vulkan-radeon vulkan-swrast</pre>}}</li>
<li> To ensure the GPU stays on, we need to use Maximilian's [https://github.com/m-weigand/mw_pinenote_misc/blob/main/systemd/mweigand_eglinfo.service mweigand_eglinfo.service]. The Readme.md in that same directory has instructions for how to install this, but basically we need to copy it to <code>/etc/systemd/system/</code>, run <code>sudo systemctl daemon-reload</code> to make sure systemd knows it exists, then execute <code>sudo systemctl enable mweigand_eglinfo.service</code></li>.
</ol>

That should be it! Now are equipped with the freshest kernel + patches.

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

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

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

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

== Fixing Bluetooth ==
Some users have noticed instability with their wireless driver. Upgrading the driver to the version provided by LibreELEC may help! To do this, download the BCM4345C0.hcd, brcmfmac43455-sdio.bin, and brcmfmac43455-sdio.txt from the [https://github.com/LibreELEC/brcmfmac_sdio-firmware/tree/master libreELEC repositories] and place them in the same location as your previous firmware (`/lib/firmware/brmc/`). Then rename brcmfmac43455-sdio.{txt,bin} as `brcmfmac43455-sdio.pine64,pinenote-v1.2.{txt,bin}`. If this doesn't help, ask about it in the matrix chat!

=== Autoconnect to your Bluetooth devices ===
This [https://github.com/jrouleau/bluetooth-autoconnect bluetooth-autoconnect project] may help.

==== Preliminary fix for stuttering bluetooth audio: ====
Following a fix used for the Quartz Model A (which uses the same SoC as the Pinenote), we can modify the device tree prior to building the kernel to try to mitigate poor bluetooth audio streaming. (reference: see https://lore.kernel.org/linux-arm-kernel/20220926055435.31284-1-leo@nabam.net/T/)

===== Steps: =====

* Open arch/arm64/boot/dts/rockchip/rk3566-pinenote.dtsi
* Go to line 939, "bluetooth", under the "uart1" section
* Edit the two lines that read "device-wake-gpios" and "host-wake-gpios"; you want them to read "device-wakeup-gpios" and "host-wakeup-gpios" respectively
* Add the following line to the end of the bluetooth section (under the vddio-supply line in my .dtsi): "max-speed = <3000000>;"
* Count your zeros, don't forget your punctuation..

===== Caveats: =====

This will improve BT audio quality at least when using the AAC codec. In my experience, the quality is more than acceptable, but there are still issues apparent: occasional isolated stutters even on AAC; prohibitively frequent stutters on SBC-XQ remain. Fully resolving BT audio issues might require further changes similar to the one described above, or may alternatively be a matter of audio software settings (e.g., process priority, audio server buffer settings). Investigation ongoing..

User:Aarondabomb/PineNote Documentation

2022-12-14T20:48:05Z

Hmpthcs:

{{Under construction}}

This space is intended to track the current status of documentation. As documentation is generated and organized in a more cohesive way, this may no longer be necessary.

== Who Can Contribute ==
Hopefully anyone! These are people who are thinking especially hard about this:
* Aarondabomb
* rjulian

== What needs to get done ==
# Reorganize the information that's already at [[PineNote Development]].
#: This means creating new pages, like [[PineNote: Getting Started]] that contains the important info.
# Create a getting started page
# Page to more clearly describe what "the project" even is
## Answer the question: Why does Pine64 sell the PineNote?
## There are a number of folks doing different things. There is no cohesive effort, but what someone else accomplishes may help you, and documenting/organizing these efforts can maximize the chances for cross-pollination.
# Outline how to get involved in the community.
#: We know there's chat, but that's not "active" involvement.
# Provide resources to learn about the technology behind the PineNote and development efforts.

== End User Personas to Consider ==
When we think of "who may buy/use a PineNote", we have to consider the personas who would purchase this:
* Hardware developers interested in e-ink and open source development
* Software developers who enjoy e-ink hardware and want to explore building software leveraging e-ink hardware.
* Technologists who understand the product category and want to experience/test out using the PineNote.
* Pure end users who want an open source/copyleft version of the remarkable 2.
* End users who have no clue about the product category (e.g. imagine they got this as a gift).

Right now, of the above personas, none of them are getting effective documentation, with hardware developers getting the most information of the bunch.

== Hardware ==
Images, diagrams and technical data of the Pinenote's internals to be added
=== System on Chip ===
=== Display ===
=== Touch Panel ===
=== Wacom ===
=== Radios ===
=== Accelerometer ===
=== Audio ===
=== USB ===
=== Stylus ===

== Software ==

=== Stock Partition Layout ===

As output by the [https://github.com/rockchip-linux/rkdeveloptool rkdeveloptool] <code>ppt</code> (print partition) command:

<pre>
**********Partition Info(GPT)**********
NO LBA Name
00 00004000 uboot
01 00006000 trust
02 00008000 waveform
03 00009000 misc
04 0000B000 dtbo
05 0000D000 vbmeta
06 0000D800 boot
07 00021800 security
08 00023800 recovery
09 00063800 backup
10 00123800 cache
11 00323800 metadata
12 0032B800 super
13 0093F800 logo
14 00947800 device
15 00967800 userdata
</pre>

In order, the partitions are:
* <code>uboot</code>: holds the [https://en.wikipedia.org/wiki/Das_U-Boot Das U-Boot] open-source bootloader for embedded systems
* <code>trust</code>: holds secrets such as keys; while such secrets are usually stored in NV-RAM or in a TPM, they can also be stored in a partition encrypted by a key held in a TPM
* <code>waveform</code>: holds files specifying the voltage waveforms applied to the charged particles in the e-ink screen to manipulate them into displaying a desired image
* <code>misc</code>: stores miscellaneous files needed by the firmware
* <code>dtbo</code>: stores [https://en.wikipedia.org/wiki/Devicetree device tree] binary files, a description of the hardware configuration of the device
* <code>vbmeta</code>: stores data needed for the verified boot process

For backup, the stock partition images are available for download [https://pwarren.id.au/pinenote/partitions/ here].

== Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

PineNote: Getting Started

2022-12-14T20:46:53Z

Hmpthcs:

PineNote: Getting Started

2022-07-27T06:39:00Z

Hmpthcs: /* Links to dotfiles, configuration examples, etc. */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== For dual boot ===
=== For linux alone ===

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

=== Kernel Compilation ===
(for now, see links above)

== Tweaks and Useful Apps ==

=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension
* Vim config: https://github.com/m-weigand/mw_pinenote_misc/tree/main/vim
* Xournal++, nwg and libinput tweaks: https://gitlab.com/hrdl/pinenote-shared/

Additional information on experimental EBC driver patch(es):
* https://github.com/m-weigand/mw_pinenote_misc
Copied from Pinenote chat:
<pre>
Everything is controlled using the sysfs parameters in /sys/module/rockchip_ebc/parameters
By default you need to write as root, but this can be easily changed via udev rules.

Enabling auto refresh:
echo 1 > /sys/module/rockchip_ebc/parameters/auto_refresh

global refreshes are triggered based on the area drawing using partial refreshes, in units of total screen area.

echo 2 > /sys/module/rockchip_ebc/parameters/refresh_threshold

therefore will trigger a global refresh whenever 2 screen areas where drawn.
</pre>

PineNote: Getting Started

2022-07-27T06:36:29Z

Hmpthcs:

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== For dual boot ===
=== For linux alone ===

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

=== Kernel Compilation ===
(for now, see links above)

== Tweaks and Useful Apps ==

=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension
* Vim config: https://github.com/m-weigand/mw_pinenote_misc/tree/main/vim
* Xournal++, nwg and libinput tweaks: https://gitlab.com/hrdl/pinenote-shared/

Additional information on experimental patch(es):
* https://github.com/m-weigand/mw_pinenote_misc
Copied from Pinenote chat:
<pre>
Everything is controlled using the sysfs parameters in /sys/module/rockchip_ebc/parameters
By default you need to write as root, but this can be easily changed via udev rules.

Enabling auto refresh:
echo 1 > /sys/module/rockchip_ebc/parameters/auto_refresh

global refreshes are triggered based on the area drawing using partial refreshes, in units of total screen area.

echo 2 > /sys/module/rockchip_ebc/parameters/refresh_threshold

therefore will trigger a global refresh whenever 2 screen areas where drawn.
</pre>

PineNote Development

2022-07-24T17:11:07Z

Hmpthcs: /* More Information */

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

= More Information =

== Notes Written by Some Developers ==

* https://pwarren.id.au/pinenote/build_notes.txt
* https://github.com/DorianRudolph/pinenotes
* https://github.com/tpwrules/nixos-pinenote

== Video of Factory Android OS ==

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

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

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

== Emulator for Developing/Testing Pinenote Apps ==
https://github.com/michaelshiel/picom-epaper

= Flashing Software =

Currently, the only ways to flash software are from the factory Android installation (UART shell, adb, or fastboot) or by using rkdeveloptool.

== Side-by-side setup ==

It is possible to set up a partition for mainline development without disturbing the factory Android installation. This allows updating a mainline kernel, DTB, and initramfs over Wi-Fi until WiFi or USB OTG is working in mainline Linux.

=== Without Repartitioning ===

The recommended partition for this is <tt>mmcblk0p11</tt> aka <tt>/cache</tt>. It is large and already formatted as <tt>ext4</tt>, so it is readable from U-Boot. Here are some general steps:

# From the UART or adb shell, set up your chroot in <tt>/cache</tt>. I used the Alpine Linux rootfs tarball.
# Copy in your kernel and DTB, using for example <tt>scp</tt> or <tt>wget</tt> inside the chroot.
# Finally, create and boot an <code>extlinux.conf</code> as described below.

=== With Repartitioning ===

It is possible to shrink the <tt>userdata</tt> partition, and create a new partition at the end for use with mainline Linux. This provides much more space than <tt>cache</tt>. However, because <tt>userdata</tt> is formatted with <tt>f2fs</tt>, and that filesystem cannot be shrunk, resizing the partition requires wiping <tt>userdata</tt>.

# Back up any necessary files from userdata
# Boot to a mainline kernel from <tt>mmcblk0p11</tt>, either using that partition as rootfs (see above), or using an initramfs with repartitioning tools
# Modify the partition table with your favorite tool, e.g. <tt>fdisk</tt>, <tt>gdisk</tt>, or <tt>parted</tt>
# Reboot into <tt>fastboot</tt> and wipe <tt>userdata</tt>.
# Reboot into Android, where you can now chroot in and install your favorite distribution to the new partition.

== Using rkdeveloptool ==

rkdeveloptool is a command line utility built on libusb.

=== Downloading and Building rkdeveloptool ===

PINE64 develops [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool its own updated fork of rkdeveloptool on GitLab].

You will need to have libusb 1.0, its development headers and scdoc installed.

<pre>
git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git
cd rkdeveloptool
mkdir build
cd build
cmake ..
</pre>

This sets up all the build files. You can then compile with <code>make</code> inside the build directory.

After you're done, you'll likely also need to install the udev rules, or else your user won't have permission to access the USB devices:

<pre>
sudo cp 99-rk-rockusb.rules /etc/udev/rules.d/
sudo udevadm control --reload
</pre>

Copying the udev rules is also performed automatically when you <code>make install</code>.

=== Building Downstream U-Boot ===

While in maskrom mode, we need to have a u-boot to download onto the device for any of the other commands to work. To build you'll also need to install device-tree-compiler.

You also need to install Python and pyelftools.

<b> Note that rkbin is a >5GB download!</b> This will take some time to clone and process the deltas.

<pre>
git clone -b quartz64 https://gitlab.com/pgwipeout/u-boot-rockchip.git
git clone -b rkbin https://github.com/JeffyCN/rockchip_mirrors.git rkbin
cd u-boot-rockchip
# If using Arch Linux, export CROSS_COMPILE=aarch64-linux-gnu-
export CROSS_COMPILE=aarch64-none-linux-gnu-
make rk3566-quartz64_defconfig
./make.sh
</pre>

<blockquote>
In the version I cloned (current as of 2022-01-02), I had to make a change to one line to get a clean compilation:

<pre>
diff --git a/lib/avb/libavb/avb_slot_verify.c b/lib/avb/libavb/avb_slot_verify.c
index 123701fc3b..64a1ce6450 100644
--- a/lib/avb/libavb/avb_slot_verify.c
+++ b/lib/avb/libavb/avb_slot_verify.c
@@ -296,7 +296,7 @@ static AvbSlotVerifyResult load_and_verify_hash_partition(
bool image_preloaded = false;
uint8_t* digest;
size_t digest_len;
- const char* found;
+ const char* found = NULL;
uint64_t image_size;
size_t expected_digest_len = 0;
uint8_t expected_digest_buf[AVB_SHA512_DIGEST_SIZE];
</pre>

For systems where the global python executable points to python2, compilation fails with an error related to pyelftools not being installed (even if it is). To fix this:
<pre>
diff --git a/make.sh b/make.sh
index 2bba05b4e4..cfe5b0afd5 100755
--- a/make.sh
+++ b/make.sh
@@ -758,7 +758,7 @@ function pack_fit_image()
fi

if [ "${ARM64_TRUSTZONE}" == "y" ]; then
- if ! python -c "import elftools" ; then
+ if ! python3 -c "import elftools" ; then
echo "ERROR: No python 'pyelftools', please: pip install pyelftools"
exit 1
fi
</pre>
</blockquote>

=== Entering Maskrom Mode ===

There are two ways to get into Maskrom mode:

==== The easy way ====

# Flip the device around so that the display faces down
# Lay the pen on the right side, with its tip pointing towards the speaker grill, and its magnet pointing towards the upper right corner of the label on the back.
# Turn the device on and wait for it to show up in <code>lsusb</code>. It should now be in Loader mode, according to <code>rkdeveloptool list-devices</code>
# Unplug the device and plug it back in. It should now be in maskrom mode.

This can be a bit fiddly to get right, and may need a few tries.

==== Shorting test points ====

If the bootloader is broken/corrupted, you cannot get to Maskrom without opening up the device (it can be opened using spudger and a bit of patience).

Once inside, short TP1301 and TP1302 with a small tweezers, this is how it looks on board view (credit to Caleb):

[[File:PineNote_Maskrom_TP.png|500px]]

Then plug the device to the computer and if you see the device with VID=2207/PID=350a then it should be in Maskrom mode, you can verify by typing <code>rkdeveloptool list-devices</code>.

<nowiki>Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device found, idVendor=2207, idProduct=350a, bcdDevice= 1.00
Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device strings: Mfr=0, Product=0, SerialNumber=0

$ rkdeveloptool list-devices
DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom</nowiki>

If nothing shows up, you can try to hold down the power button for 5 seconds and then try again.

=== Running rkdeveloptool ===

First, you'll want to make sure the device you've connected is in maskrom mode:

<pre>
./rkdeveloptool list
</pre>

It should output something like <code>DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=202 Maskrom</code>. If it doesn't, see [[PineNote Development#Entering Maskrom Mode]].

You can now download u-boot onto it:
<pre>
./rkdeveloptool boot ../u-boot-rockchip/rk356x_spl_loader_v1.08.111.bin
</pre>

This should output <code>Downloading bootloader succeeded.</code>.

We can now verify that this worked using e.g. the "read flash info" command:

<pre>
./rkdeveloptool read-flash-info
</pre>

'''TODO:''' finish this section

=== Creating a mainline boot image ===

You can create a filesystem image that replaces the Android boot or recovery partition by doing roughly the following:

# Erase boot and dtbo with rkdeveloptool or fastboot (back them up first!!!)
# Create an ext2 partition image and mount it (fallocate, mkfs.ext2)
# Build your mainline kernel
# Copy the kernel, dtb and an initramfs to the root of the mounted image (use any old postmarketOS initramfs)
# Create a file in the root of the mounted image called <code>extlinux.conf</code> as described below
# Unmount the image and then use rkdeveloptool to flash it to the "recovery" partition on the pinenote (it's about the right size until we get around to replacing the partition layout).

== Using fastboot ==

Follow the steps for "Creating a mainline boot.img", but instead of flashing it with rkdeveloptool, use fastboot. You can enter fastboot in either of two ways:

# Use "reboot bootloader" from adb or a UART console.
# Get a U-Boot prompt and run <code>fastboot usb 0</code>.

= Mainline development =

== Status ==

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

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

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

== How to boot mainline ==

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

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

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

You can get to a U-Boot prompt by:

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

=== Using sysboot ===

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

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

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

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

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

=== Booting with individual commands ===

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

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

== Configuration ==

=== Firmware ===

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

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

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

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

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

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

PineNote: Getting Started

2022-07-24T17:07:21Z

Hmpthcs: /* For Linux alone */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== For dual boot ===
=== For linux alone ===

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

=== Kernel Compilation ===
(for now, see links above)
Additional information on experimental patch(es):
* https://github.com/m-weigand/mw_pinenote_misc

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension
* Vim config: https://github.com/m-weigand/mw_pinenote_misc/tree/main/vim
* Xournal++, nwg and libinput tweaks: https://gitlab.com/hrdl/pinenote-shared/

PineNote: Getting Started

2022-07-24T17:07:09Z

Hmpthcs: /* Setting up Partitions */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== For dual boot ===
=== For Linux alone ===

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

=== Kernel Compilation ===
(for now, see links above)
Additional information on experimental patch(es):
* https://github.com/m-weigand/mw_pinenote_misc

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension
* Vim config: https://github.com/m-weigand/mw_pinenote_misc/tree/main/vim
* Xournal++, nwg and libinput tweaks: https://gitlab.com/hrdl/pinenote-shared/

PineNote: Getting Started

2022-07-24T17:05:45Z

Hmpthcs: /* Links to dotfiles, configuration examples, etc. */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

=== Kernel Compilation ===
(for now, see links above)
Additional information on experimental patch(es):
* https://github.com/m-weigand/mw_pinenote_misc

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension
* Vim config: https://github.com/m-weigand/mw_pinenote_misc/tree/main/vim
* Xournal++, nwg and libinput tweaks: https://gitlab.com/hrdl/pinenote-shared/

PineNote: Getting Started

2022-07-24T17:02:52Z

Hmpthcs: /* Installing Linux */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

=== Kernel Compilation ===
(for now, see links above)
Additional information on experimental patch(es):
* https://github.com/m-weigand/mw_pinenote_misc

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension

PineNote: Getting Started

2022-07-24T17:00:07Z

Hmpthcs: /* Links to dotfiles, configuration examples, etc. */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and
* Gnome extension: https://github.com/m-weigand/mw_pinenote_misc/tree/main/gnome_extension

PineNote: Getting Started

2022-07-24T16:29:13Z

Hmpthcs: /* Stock Partition Layout */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
<pre>
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
</pre>

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and

PineNote: Getting Started

2022-07-24T16:27:23Z

Hmpthcs:

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

=== Stock Partition Layout ===
Backups: https://pwarren.id.au/pinenote/partitions/

Copied from DorianRudolph's github instructions (link at the end of this document):
```
> rkdeveloptool list-partitions
# LBA start (sectors) LBA end (sectors) Size (bytes) Name
00 16384 24575 4194304 uboot
01 24576 32767 4194304 trust
02 32768 36863 2097152 waveform
03 36864 45055 4194304 misc
04 45056 53247 4194304 dtbo
05 53248 55295 1048576 vbmeta
06 55296 137215 41943040 boot
07 137216 145407 4194304 security
08 145408 407551 134217728 recovery
09 407552 1193983 402653184 backup
10 1193984 3291135 1073741824 cache
11 3291136 3323903 16777216 metadata
12 3323904 9697279 3263168512 super
13 9697280 9730047 16777216 logo
14 9730048 9861119 67108864 device
15 9861120 241827775 118766927872 userdata
```

== General Overview of Linux Installation Process ==
Todo: This section should provide instructions for using UART, adb and rkdeveloptool on the Pinenote for users unfamiliar with or new to any of them.

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and

PineNote: Getting Started

2022-07-24T16:19:22Z

Hmpthcs: /* Installing Linux */

{{Under construction}}

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

Anyone! Generally, the PineNote is in a very early state, and at least an intermediate level of linux knowledge is probably necessary to be able to do anything at this moment. That said, there are multiple efforts happening at once, and there are a number of ways a person of any skill level can help:
# Join in the ongoing documentation effort here: [[PineNote Documentation]].
# Help mainline the kernel by testing, fixing bugs.

== Out of the Box ==
=== Information on software shipped with the Pinenote ===
As of July 2022, the Pinenote ships with a modified version of android. Under this OS, users interested only in reading ebooks and possibly leaking data to unknown parties may find the device more than satisfactory (read: use caution when handling ultra personal or sensitive data). All hardware items are functional with this OS, though the ability to tune and tweak may be limited by the proprietary nature of some drivers (e.g., the driver for the e-ink display). Ongoing support for this OS is absent, though further community development is possible and hoped for by more than a few users already.

Apps preloaded with this OS include:
* Xphoto
* WPS Office Lite
* Browser from Tencent (would urge users to replace/remove)
* Core: Notes (stylus-driven note app), Local Storage (file browser), Task List (notes list with text and handwriting input)
* Application Management
* More Settings

Additional apps may be added via the included browser; for example, F-droid can be installed and then used to install further android apps.

The main bar drawn along the screen's top edge features buttons for accessing the following, from left-to-right:

* Home (house icon; opens additional bar along the screen's left edge for accessing notes and file management apps)
* Refresh screen
* Installed Apps (four squares)
* Active Apps (bulleted list of three lines)
* Settings (gear icon)
* Back
* Wifi Menu
* Bluetooth Stylus Menu (pairing included stylus allows use of hardware buttons on the stylus)

When hidden by an open app, this bar can be made to reappear by swiping downward anywhere along the screen's top edge.

=== Accessories included in the box ===

As of July 2022, the Pinenote ships with the following items in the box:

* Pinenote (duh)
* Stylus
* USB-c to USB-a cable
* USB-c to micro-b cable (for stylus)
* UART dongle

== Stock Partition Layout ==

== General Overview of Linux Installation Process ==

=== Prerequisites ===
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Setting up Partitions ==
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

Without modifying the bootloader, u-boot will automatically load android. Under these circumstances, an alternative OS may be loaded by manually inputting commands to the u-boot terminal, which must be accessed by sending an interrupt signal (ctrl+c) to the device via UART during boot. Thus modifying u-boot is not, strictly speaking, necessary but will be desirable for most users wishing to use linux as their primary OS in a dual boot arrangement.

There exists more than one approach to avoid having to do this each time the device is restarted. Two of these are detailed below.

=== Option 1: Build U-boot from Scratch ===
reference: https://github.com/JoshuaMulliken/pinenote_uboot

=== Option 2: Extract and Modify Existing U-boot Image ===
reference: https://gist.github.com/charasyn/206b2537534b6679b0961be64cf9c35f

== Installing Linux ==
References:
* https://github.com/DorianRudolph/pinenotes
* https://musings.martyn.berlin/dual-booting-the-pinenote-with-android-and-debian
* https://wiki.postmarketos.org/wiki/PINE64_PineNote_(pine64-pinenote)

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===
* Sway config, Mesa for hardware-acceleration using GPU, KO reader : https://github.com/0cc4m/pinenote-misc
* Setting up X: https://musings.martyn.berlin/setting-up-x-on-the-pinenote-in-debian-with-touchscreen-onboard-keyboard-and

PineNote: Getting Started

2022-07-24T16:13:29Z

Hmpthcs: /* Information on software shipped with the Pinenote */

PineNote: Getting Started

2022-07-24T16:12:35Z

Hmpthcs: /* Modifying the Bootloader */

PineNote: Getting Started

2022-07-24T16:09:31Z

Hmpthcs: /* Modifying the Bootloader */

PineNote: Getting Started

2022-07-24T16:00:33Z

Hmpthcs:

User:Aarondabomb/PineNote Documentation

2022-07-24T06:39:56Z

Hmpthcs: /* Hardware */

PineNote: Getting Started

2022-07-24T06:34:09Z

Hmpthcs: /* Modifying the Bootloader */

PineNote: Getting Started

2022-07-24T06:28:15Z

Hmpthcs: /* Information on software shipped with the Pinenote */

PineNote: Getting Started

2022-07-24T06:26:45Z

Hmpthcs: /* Information on software shipped with the Pinenote */

PineNote: Getting Started

2022-07-24T06:22:18Z

Hmpthcs: /* Information on software shipped with the Pinenote */

PineNote: Getting Started

2022-07-24T06:15:44Z

Hmpthcs: /* Background / Intro */

PineNote: Getting Started

2022-07-24T06:13:44Z

Hmpthcs: /* Accessories included in the box (UART dongle; USB-C to USB-A cable; stylus) */

PineNote: Getting Started

2022-07-24T06:10:06Z

Hmpthcs: /* Information on software shipped with the Pinenote */

User:Aarondabomb/PineNote Documentation

2022-07-24T06:08:29Z

Hmpthcs:

User:Aarondabomb/PineNote Documentation

2022-07-24T05:57:30Z

Hmpthcs:

PineNote: Getting Started

2022-06-05T00:32:27Z

Hmpthcs:

This page is a work in progress. Its goals are to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

== Background / Intro ==
=== Information on software shipped with the Pinenote ===
=== Accessories included in the box (UART dongle; USB-C to USB-A cable; stylus) ===

== Prerequisites ==
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Partitions ==
=== Factory setup ===
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

== Installing Linux ==

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===

PineNote: Getting Started

2022-06-05T00:30:28Z

Hmpthcs: Created page with "This page is a work in progress. Its goal is to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions. == Who Can Contribute == == Background / Intro == === Information on software shipped with the Pinenote === === Accessories include..."

This page is a work in progress. Its goal is to help users get their devices up and running while minimizing redundancy with other pages (e.g., Documentation, Development), and to synthesize information provided in existing guides. Sections below represent a rough outline and will need to be expanded with details and further instructions.

== Who Can Contribute ==

== Background / Intro ==
=== Information on software shipped with the Pinenote ===
=== Accessories included in the box (UART dongle; USB-C to USB-A cable; stylus) ===

== Prerequisites ==
* This section should provide the user with a listing of required software, e.g., for cross-compiling; communicating via UART, etc.
* The following sections should walk the user through the process of going from a factory-fresh device to a functional e-ink tablet running linux.

== Partitions ==
=== Factory setup ===
=== Possible configurations for ===
* dual boot
* linux alone

== Modifying the Bootloader ==

== Installing Linux ==

== Choosing Your GUI ==

== Tweaks and Useful Apps ==
=== Links to dotfiles, configuration examples, etc. ===