User:Aarondabomb/PineNote Development/Building Kernel new - Revision history

Fxc: Fxc moved page PineNote Development/Building Kernel new to User:Aarondabomb/PineNote Development/Building Kernel new: User draft, please integrate into main article or edit it in the user space, otherwise this creates chaos

2023-01-12T19:02:32Z

Fxc moved page PineNote Development/Building Kernel new to User:Aarondabomb/PineNote Development/Building Kernel new: User draft, please integrate into main article or edit it in the user space, otherwise this creates chaos

← Older revision

Revision as of 19:02, 12 January 2023

Aarondabomb at 16:02, 10 October 2022

2022-10-10T16:02:24Z

← Older revision		Revision as of 16:02, 10 October 2022
Line 1:		Line 1:
	= Building the Kernel =		= Building the Kernel =
			To get your PN running this smoothly, we'll need to build our own kernel. There are two major kernel efforts:
	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 major kernel efforts:

	# pgwipeout: https://gitlab.com/pgwipeout/linux-next		# pgwipeout: https://gitlab.com/pgwipeout/linux-next
Line 10:		Line 9:
	# maximilian: https://github.com/m-weigand/linux		# maximilian: https://github.com/m-weigand/linux

	~~Of course, most~~ of the work ~~in the kernel~~ has been in creating a DRM driver for the eink display. You can learn more about the driver by reading [https://lore.kernel.org/linux-rockchip/20220413221916.50995-1-samuel@sholland.org/T/ Smaeul's RFC].		Most of the kernel work has been in creating a DRM driver for the eink display. You can learn 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 ===		=== A small warning ===
Line 19:		Line 18:
	== What you should have already done ==		== 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]~~.		This guide will help you build the latest kernel and move it to your PineNote, but it does not cover installing an operating system. You should either already have a linux distro in place, or you should be following Dorian's guide to get Arch installed and use this guide to replace the steps described in [https://github.com/DorianRudolph/pinenotes#compile-the-kernel Compiling the Kernel].

			Some steps from his guide (especially the commands to build the kernel) were borrowed from Dorian's guide. Thanks to Dorian for his work.

	TODO: rewrite this guide in the wiki.		TODO: rewrite this guide in the wiki.
Line 25:		Line 26:
	== What do you need to know? ==		== 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.		Compiling a kernel is not very complicated compared to some of the other steps required to put an operating system on the PineNote. You'll be fine :) If you are intimidated, that's okay! I'd still encourage you to try -- you will learn a lot. Just be patient and back up any data you're worried you might lose. 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 ==		== Steps to build ==
Line 41:		Line 42:
	export ARCH=arm64		export ARCH=arm64
	</li>		</li>
			<li> Build the kernel:
			<pre>
			make clean
			make pinenote_defconfig
			make -j $(nproc) all
			</pre>
			</li>
	</ol>		</ol>
	</li>		</li>

Aarondabomb at 15:51, 10 October 2022

2022-10-10T15:51:43Z

← Older revision		Revision as of 15:51, 10 October 2022
Line 32:		Line 32:
	<li> Clone Maximilian's repository: </li>		<li> Clone Maximilian's repository: </li>
	<pre> $ git clone https://github.com/m-weigand/linux.git </pre>		<pre> $ git clone https://github.com/m-weigand/linux.git </pre>
	<li> </li>		<li> If this is your first Kernel, download the arm toolchain. Which version you want depends on your host machine (the machine which will do the compiling). The target machine is the PineNote, which is a <pre>AArch64 GNU/Linux target (aarch64-none-linux-gnu)</pre> target.
	<li> Compile the kernel: </li>		</li>
	<pre> ~~$ sh~~ ./~~mw_pinenote_misc~~/~~custom_kernel~~/~~compile.sh~~ </~~pre~~>		<li> Compile the kernel:
			<ol>
			<li> Set the necessary environment variables:
			<pre>
			export CROSS_COMPILE="<PATH_TO_TOOLCHAIN>/arm-gnu-toolchain-11.3.rel1-x86_64-aarch64-none-linux-gnu/bin/aarch64-none-linux-gnu-"
			export ARCH=arm64
			</li>
			</ol>
			</li>
	<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.		<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>		<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>

Aarondabomb: Created page with "= 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 major kern..."

2022-10-10T15:33:38Z

Created page with "= 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 major kern..."

New page

= 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 major kernel efforts:

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

And then there is a third effort adding to smaeul's efforts by incorporating various community patches and several new features:

# maximilian: https://github.com/m-weigand/linux

Of course, most of the work in the kernel has been in creating a DRM driver for the eink display. You can learn 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 ===
These changes are all experimental and may damage your panel. However, there have been no confirmed instances of damage from this work and only a few mysterious hardware issues that may be entirely unrelated.

{{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].

TODO: rewrite this guide in the wiki.

== 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 repository: </li>
<pre> $ git clone https://github.com/m-weigand/linux.git </pre>
<li> </li>
<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. 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.