User:Talpa/Using rkdeveloptool - Revision history

Fxc: Fxc moved page PineNote Development/Using rkdeveloptool to User:Talpa/Using rkdeveloptool without leaving a redirect: Copy of PineNote_Development/Flashing. Please don't draft in the main article space

2023-04-07T23:33:10Z

Fxc moved page PineNote Development/Using rkdeveloptool to User:Talpa/Using rkdeveloptool without leaving a redirect: Copy of PineNote_Development/Flashing. Please don't draft in the main article space

← Older revision

Revision as of 23:33, 7 April 2023

Fxc: Fix

2023-03-16T03:09:45Z

Fix

← Older revision		Revision as of 03:09, 16 March 2023
Line 5:		Line 5:
	rkdeveloptool can among other things read and write to the eMMC inside the PineNote.		rkdeveloptool can among other things read and write to the eMMC inside the PineNote.

	It is therefor useful for [[~~PineNote_Development~~/Backup \| backups]] and installing an OS to the PineNote.		It is therefor useful for [[PineNote Development/Backup\|backups]] and installing an OS to the PineNote.

	== About the boot process of the PineNote ==		== About the boot process of the PineNote ==

Talpa: Information about sending the SPL when in Maskrom mode

2023-01-15T20:10:40Z

Information about sending the SPL when in Maskrom mode

← Older revision		Revision as of 20:10, 15 January 2023
Line 106:		Line 106:
	DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom		DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom

			==== Sending the loader to the RK3566 (Not needed in "Loader"/rockusb mode) ====
			In Maskrom you must first send a SPL (Secondary program loader) with contains the drivers for accessing the eMMC.

			The spl_loader .bin file can be obtained by compiling the downstream u-boot, the version number may or may not match the one displayed below depending on the sources used.

			The spl .bin file is send and executed using the ''rkdeveloptool boot'' command, see below:

			rkdeveloptool boot rk356x_spl_loader_v1.08.111.bin

			This should output "Downloading bootloader succeeded".

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

			rkdeveloptool read-flash-info

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

	[[Category:PineNote]]		[[Category:PineNote]]

Talpa: Mentions the two different modes

2023-01-15T19:55:25Z

Mentions the two different modes

← Older revision		Revision as of 19:55, 15 January 2023
Line 47:		Line 47:

	There are three ways to get into Maskrom/Rockusb mode:		There are three ways to get into Maskrom/Rockusb mode:

			The first two will result in Rockusb mode where drivers for the eMMC are loaded and rkdeveloptool can be used without further action.
			This mode can be identified by ''Loader'' in the output when running <code>rkdeveloptool list</code>
			rkdeveloptool list
			DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=402 Loader

			The last method is used to recover from a bad u-boot and leaves the device in ''Maskrom''.
			Here rkdevelop must first be used to upload the loader code with the driver for the eMMC.
			This mode can be identified by ''Maskrom'' in the output when running <code>rkdeveloptool list</code>
			rkdeveloptool list-devices
			DevNo=1 Vid=0x2207,Pid=0x350a,LocationID=10e Maskrom

	=== The magnet way ===		=== The magnet way ===

Fxc: fix

2023-01-15T19:08:03Z

fix

← Older revision		Revision as of 19:08, 15 January 2023
Line 1:		Line 1:
	= Using rkdeveloptool =		= Using rkdeveloptool =

	rkdeveloptool is a command line tool that can communicate with a some Rockchip SOCs like the RK3566 in the PineNote when they are in ~~maskrom~~/~~rockusb~~ mode.		rkdeveloptool is a command line tool that can communicate with a some Rockchip SOCs like the RK3566 in the PineNote when they are in Maskrom/Rockusb mode.

	rkdeveloptool can among other things read and write to the eMMC inside the PineNote.		rkdeveloptool can among other things read and write to the eMMC inside the PineNote.
Line 15:		Line 15:
	* SD-Card		* SD-Card

	''In the case of the PineNote there is only the eMMC''		In the case of the PineNote there is only the eMMC.

	If the SOC finds a storage device with a valid ID BLOCK it proceeds to boot from the device.		If the SOC finds a storage device with a valid ID BLOCK it proceeds to boot from the device.

	If no usable storage device is found the ROM in the SOC enters ~~maskrom~~ mode and awaits a connection over USB		If no usable storage device is found the ROM in the SOC enters Maskrom mode and awaits a connection over USB

	The PineNote additionally has a magnet sensor that is read by U-Boot during startup and if it detects a magnet U-Boot places the device in USB download mode		The PineNote additionally has a magnet sensor that is read by U-Boot during startup and if it detects a magnet U-Boot places the device in USB download mode
Line 27:		Line 27:
	Pine64 develops a [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool forked version] of the rkdeveloptool by RockChip, the following describes how to build the fork:		Pine64 develops a [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool forked version] of the rkdeveloptool by RockChip, the following describes how to build the fork:

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

	git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git		git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git

Fxc: Small style fixes

2023-01-15T19:06:57Z

Small style fixes

← Older revision		Revision as of 19:06, 15 January 2023
Line 27:		Line 27:
	Pine64 develops a [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool forked version] of the rkdeveloptool by RockChip, the following describes how to build the fork:		Pine64 develops a [https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool forked version] of the rkdeveloptool by RockChip, the following describes how to build the fork:

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

	git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git		git clone https://gitlab.com/pine64-org/quartz-bsp/rkdeveloptool.git
Line 49:		Line 49:

	=== The magnet way ===		=== The magnet way ===

	[[File:PineNoteMagnetOnBack.jpg\|right\|500px\|PineNote with magnet on circle]]		[[File:PineNoteMagnetOnBack.jpg\|right\|500px\|PineNote with magnet on circle]]

	# Remove the USB-C cable if connected		# Remove the USB-C cable if connected
	# Turn the PineNote off (press the power button for 5 seconds), and flip it around so that the display faces down		# Turn the PineNote off (press the power button for 5 seconds), and flip it around so that the display faces down
Line 61:		Line 63:
	In case it doesn't work the first time just try again.		In case it doesn't work the first time just try again.

	=== The u-~~boot~~ way ===		=== The U-Boot way ===
	# Interrupt the u-~~boot~~ startup using ''ctrl-c'' (while attached using an UART dongle)		# Interrupt the U-Boot startup using ''ctrl-c'' (while attached using an UART dongle)
	# While in u-~~boot~~ use the command <code>rockusb 0 mmc 0</code> to start Rockusb mode.		# While in U-Boot use the command <code>rockusb 0 mmc 0</code> to start Rockusb mode.

	One benefit from this is, that if you have an UART dongle that allows to simultaneous having an UART and USB connection, there is no need to plug and unplug cables and flipping the PineNote around and placing magnets.		One benefit from this is, that if you have an UART dongle that allows to simultaneous having an UART and USB connection, there is no need to plug and unplug cables and flipping the PineNote around and placing magnets.

	This is especially helpful when changing back and forth between U-Boot and Rockusb, for ~~instance~~ when trying to develop u-~~boot~~.		This is especially helpful when changing back and forth between U-Boot and Rockusb, for example when trying to develop on U-Boot.

	=== Shorting test points ===		=== Shorting test points ===

Talpa: Added a image with a PineNote with a magnet on the back

2023-01-15T19:00:48Z

Added a image with a PineNote with a magnet on the back

← Older revision		Revision as of 19:00, 15 January 2023
Line 49:		Line 49:

	=== The magnet way ===		=== The magnet way ===
			[[File:PineNoteMagnetOnBack.jpg\|right\|500px\|PineNote with magnet on circle]]
	# Remove the USB-C cable if connected		# Remove the USB-C cable if connected
	# Turn the PineNote off (press the power button for 5 seconds), and flip it around so that the display faces down		# Turn the PineNote off (press the power button for 5 seconds), and flip it around so that the display faces down
Line 82:		Line 82:
	Perform the short using one of:		Perform the short using one of:
	* A small tweezers		* A small tweezers
	* The programming pogo pins for a PineTime (mask the two unused pins with tape), the spring loaded nature helps ~~get~~ a good contact		* The programming pogo pins for a PineTime (mask the two unused pins with tape), the spring loaded nature of pogo pins helps getting a good contact
	When shorting the test pads take great care to not short / touch other components or scratch the PCB as this '''may damage your PineNote'''.		When shorting the test pads take great care to not short / touch other components or scratch the PCB as this '''may damage your PineNote'''.

Talpa: Added using the circle and ensuring that the device is off before trying to get into rockusb

2023-01-15T18:48:43Z

Added using the circle and ensuring that the device is off before trying to get into rockusb

← Older revision		Revision as of 18:48, 15 January 2023
Line 50:		Line 50:
	=== The magnet way ===		=== The magnet way ===

	# ~~Flip~~ the ~~device~~ around so that the display faces down		# Remove the USB-C cable if connected
	# 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 (or place the magnetic cap from the pen on the spot marked on the back).		# Turn the PineNote off (press the power button for 5 seconds), and flip it around so that the display faces down
	# ~~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> (note that ''Loader'' here indicates U-Boot's Rockusb; separately, booting with an erased eMMC displays ''Maskrom'' (not ''Loader'') from the RK3566).		# Place a magnet in the correct place on the back of the PineNote, use one of the following methods:
	~~# Unplug the device and plug it back in. It should now be in Rockusb mode~~.		#* Place a magnet on the small circle printed on the back, the pens magnetic cap can be used for this.
			#* 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 (or place the magnetic cap from the pen on the spot marked on the back).
			# Connect the PineNote to the PC using a USB-C cable, this will wake it up and boot. Wait for it to show up in <code>lsusb</code>.

	~~This can~~ be ~~a bit fiddly~~ to ~~get right and may need a few tries~~.		It should now be in Loader mode, according to <code>rkdeveloptool list-devices</code> (note that ''Loader'' here indicates U-Boot's Rockusb; separately, booting with an erased eMMC displays ''Maskrom'' (not ''Loader'') from the RK3566).

			In case it doesn't work the first time just try again.

	=== The u-boot way ===		=== The u-boot way ===

Fxc: style fix

2023-01-15T14:29:31Z

style fix

← Older revision		Revision as of 14:29, 15 January 2023
Line 10:		Line 10:
	When the RK3566 is powered on it checks the attached storage devices in the ''boot order'':		When the RK3566 is powered on it checks the attached storage devices in the ''boot order'':

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

	''In the case of the PineNote there is only the eMMC''		''In the case of the PineNote there is only the eMMC''
Line 22:		Line 22:

	The PineNote additionally has a magnet sensor that is read by U-Boot during startup and if it detects a magnet U-Boot places the device in USB download mode		The PineNote additionally has a magnet sensor that is read by U-Boot during startup and if it detects a magnet U-Boot places the device in USB download mode


	== Compiling rkdeveloptool ==		== Compiling rkdeveloptool ==
Line 30:		Line 29:
	You will need to have libusb 1.0, its development headers and scdoc installed.		You will need to have libusb 1.0, its development headers and scdoc installed.

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

	This sets up all the build files. You can then compile with <code>make</code> inside the build directory.		This sets up all the build files. You can then compile with <code>make</code> inside the build directory.
Line 40:		Line 39:
	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:		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:

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

	Copying the udev rules is also performed automatically when you <code>make install</code>.		Copying the udev rules is also performed automatically when you <code>make install</code>.
Line 81:		Line 80:
	* The programming pogo pins for a PineTime (mask the two unused pins with tape), the spring loaded nature helps get a good contact		* The programming pogo pins for a PineTime (mask the two unused pins with tape), the spring loaded nature helps get a good contact
	When shorting the test pads take great care to not short / touch other components or scratch the PCB as this '''may damage your PineNote'''.		When shorting the test pads take great care to not short / touch other components or scratch the PCB as this '''may damage your PineNote'''.



	While keeping the test pads shorted 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>.		While keeping the test pads shorted 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>.

	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 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		Jan 07 15:04:13 melttower kernel: usb 1-14: New USB device strings: Mfr=0, Product=0, SerialNumber=0

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

Talpa: Copied in the how to get into rockusb mode and added some warnings

2023-01-15T13:52:04Z

Copied in the how to get into rockusb mode and added some warnings

@@ Line 1: / Line 1: @@
 = Using rkdeveloptool =
-rkdeveloptool is a command line tool that can communicate with a some Rockchip SOCs like the RK3566 in the PineNote when they are in maskrom/download mode.
+rkdeveloptool is a command line tool that can communicate with a some Rockchip SOCs like the RK3566 in the PineNote when they are in maskrom/rockusb mode.
 rkdeveloptool can among other things read and write to the eMMC inside the PineNote.
@@ Line 44: / Line 44: @@
 Copying the udev rules is also performed automatically when you <code>make install</code>.
 [[Category:PineNote]]