-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #119 from printfinn/rk3568-soft
Add RK3568 software docs.
- Loading branch information
Showing
16 changed files
with
195 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions
24
docs/source/PCs/ARM/RK3568/Manuals/Software/Android_11.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.. |systemType| replace:: Android 11 | ||
.. |chip| replace:: RK3568 | ||
|
||
|systemType| OS | ||
############### | ||
|
||
.. rst-class:: fs-3 fw-bold text-center | ||
|
||
|systemType| OS on |chip| User Manual | ||
|
||
|
||
.. image:: /Media/Chipsee_Logo_Full.png | ||
:align: center | ||
:width: 320 | ||
:alt: chipsee-logo | ||
|
||
Flashing OS Image | ||
================= | ||
|
||
.. include:: Resources/Download_Required_Tools_And_Image | ||
|
||
.. include:: Resources/Flash_OS | ||
|
||
.. include:: Resources/Development_On_Going |
24 changes: 24 additions & 0 deletions
24
docs/source/PCs/ARM/RK3568/Manuals/Software/Buildroot_Linux_Qt_5_15.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.. |systemType| replace:: Buildroot Linux Qt 5.15 | ||
.. |chip| replace:: RK3568 | ||
|
||
|systemType| OS | ||
############### | ||
|
||
.. rst-class:: fs-3 fw-bold text-center | ||
|
||
|systemType| OS on |chip| User Manual | ||
|
||
|
||
.. image:: /Media/Chipsee_Logo_Full.png | ||
:align: center | ||
:width: 320 | ||
:alt: chipsee-logo | ||
|
||
Flashing OS Image | ||
================= | ||
|
||
.. include:: Resources/Download_Required_Tools_And_Image | ||
|
||
.. include:: Resources/Flash_OS | ||
|
||
.. include:: Resources/Development_On_Going |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.. |systemType| replace:: Debian 11 | ||
.. |chip| replace:: RK3568 | ||
|
||
|systemType| OS | ||
############### | ||
|
||
.. rst-class:: fs-3 fw-bold text-center | ||
|
||
|systemType| OS on |chip| User Manual | ||
|
||
|
||
.. image:: /Media/Chipsee_Logo_Full.png | ||
:align: center | ||
:width: 320 | ||
:alt: chipsee-logo | ||
|
||
Flashing OS Image | ||
================= | ||
|
||
.. include:: Resources/Download_Required_Tools_And_Image | ||
|
||
.. include:: Resources/Flash_OS | ||
|
||
.. include:: Resources/Development_On_Going |
6 changes: 6 additions & 0 deletions
6
docs/source/PCs/ARM/RK3568/Manuals/Software/Resources/Development_On_Going
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Notice | ||
====== | ||
|
||
.. rst-class:: fs-5 fst-italic | ||
|
||
(This |systemType| OS User Manual is under active development as of 2023.5.23) |
25 changes: 25 additions & 0 deletions
25
docs/source/PCs/ARM/RK3568/Manuals/Software/Resources/Download_Required_Tools_And_Image
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
Download Required Tools | ||
----------------------- | ||
|
||
You need two tools to flash the |systemType| OS image to the |chip| PC. | ||
The first is *DriverAssistant_v5.1.1*, the second is *RKDevTool_v2.93*, you can `download all of them here <https://chipsee-tmp.s3.amazonaws.com/SourcesArchives/RK3568/Tools/RKDevTool_Release_v2.93.zip>`_. | ||
|
||
These tools are Windows executables, please execute them on a Windows machine. | ||
|
||
If you've been using a prior version of *DriverAssistant*, click uninstall before installing *DriverAssistant_v5.1.1*. | ||
|
||
.. image:: /Media/ARM/A55/Software/DriverAssistant_1.png | ||
:align: center | ||
:alt: DriverAssistant_1 | ||
:class: mb-4 | ||
:width: 576 | ||
|
||
.. image:: /Media/ARM/A55/Software/DriverAssistant_2.png | ||
:align: center | ||
:alt: DriverAssistant_1 | ||
:class: mb-4 | ||
:width: 384 | ||
|
||
Download Prebuilt OS Images | ||
--------------------------- | ||
If you haven't downloaded the prebuilt OS images, you can :ref:`find one here <RK3568_OSDownloads>`. |
71 changes: 71 additions & 0 deletions
71
docs/source/PCs/ARM/RK3568/Manuals/Software/Resources/Flash_OS
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
Start Flashing | ||
-------------- | ||
|
||
After installing the DriverAssistant, you can now start to flash an OS image to the |chip| board with *RKDevTool*. Double click the program to start flashing. The tool has English and Chinese language support. | ||
|
||
.. image:: /Media/ARM/A55/Software/RkDevTool.png | ||
:align: center | ||
:alt: RkDevTool | ||
:class: mb-4 | ||
:width: 576 | ||
|
||
**STEP 1**: | ||
|
||
#. Connect the Type-C cable and power on the board. (If unexpected messages occurs at any of the following steps, try plugging the Type-C cable again.) | ||
#. Click **Upgrade Firmware** tab. | ||
#. Click **Firmware** button to select a .img |systemType| image file. The screenshots show a debian11 img file is selected, but this is applicable to other OSes as well. | ||
|
||
|
||
.. image:: /Media/ARM/A55/Software/Flash_1.png | ||
:align: center | ||
:alt: Flash_1 | ||
:class: mb-4 | ||
:width: 768 | ||
|
||
**STEP 2**: | ||
|
||
#. Click **Switch** button to switch the device to a Loader device. | ||
|
||
.. image:: /Media/ARM/A55/Software/Flash_2.png | ||
:align: center | ||
:alt: Flash_2 | ||
:class: mb-4 | ||
:width: 768 | ||
|
||
**STEP 3**: | ||
|
||
#. You should see "Found One LOADER Device". | ||
#. Click **Advanced Function** tab. | ||
#. Click **EraseAll** button. | ||
#. You should see "Erasing sectors success" on the right side logs. | ||
|
||
.. image:: /Media/ARM/A55/Software/Flash_3.png | ||
:align: center | ||
:alt: Flash_3 | ||
:class: mb-4 | ||
:width: 768 | ||
|
||
**STEP 4**: | ||
|
||
#. Click **Upgrade Firmware** tab. | ||
#. Click **Upgrade** button. | ||
#. You should see Download Firmware progress on the right side logs. | ||
|
||
.. image:: /Media/ARM/A55/Software/Flash_4.png | ||
:align: center | ||
:alt: Flash_4 | ||
:class: mb-4 | ||
:width: 768 | ||
|
||
**STEP 5**: | ||
|
||
#. After the download firmware progress goes to 100%, the board reboots itself automatically. | ||
#. After a few minutes, you should see "Found One ADB Device". | ||
#. Now your new OS is ready for use. | ||
|
||
.. image:: /Media/ARM/A55/Software/Flash_5.png | ||
:align: center | ||
:alt: Flash_5 | ||
:class: mb-4 | ||
:width: 768 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
RK3568 Software Documentation | ||
############################# | ||
|
||
This section contains the software documentation for flashing new operating systems (OS) on products based on RockChip RK3568 chips. | ||
If you have questions not covered in this documentation, please consult Chipsee Technical Support at |email|_. | ||
|
||
.. _RK3568_OS: | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:titlesonly: | ||
|
||
Debian 11 <Debian_11> | ||
Android 11 <Android_11> | ||
Buildroot Linux Qt 5.15 <Buildroot_Linux_Qt_5_15> | ||
|
||
.. warning:: | ||
|
||
| All Chipsee products come with the pre-installed OS selected upon ordering. | ||
| Chipsee assumes no liability for the damage caused due to improper installation by the third parties. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters