Skip to content

Commit

Permalink
rk3399-vaaman : Separate Folder for Vaaman Specific Images
Browse files Browse the repository at this point in the history
    vaaman: change path of vaaman specific images
    linux-sdk : Add link vaaman-sdk-boot page

Signed-off-by: avi951 <[email protected]>
  • Loading branch information
avi951 authored and bojle committed Jul 1, 2024
1 parent ea8a8c0 commit 4dab1e7
Show file tree
Hide file tree
Showing 62 changed files with 93 additions and 94 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Vicharak brings to you the powerful rk3399 based Vaaman and the highly advanced
Designed for both hobbyists and professionals, these SBCs offer unparalleled performance and versatility for a wide range of
applications including IoT, AI and multimedia processing.

.. |vaaman_top| image:: _static/images/Vaaman-top.webp
.. |vaaman_top| image:: _static/images/rk3399-vaaman/Vaaman-top.webp
:width: 100%
:alt: vaaman top

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Heat Sink Accessory
#####################

.. image:: ../../../_static/images/accessory-heatsink.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-heatsink.webp
:width: 50%
:align: center

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
M.2 Expansion Board
#####################

.. image:: ../../../_static/images/accessory-nvme-module.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-nvme-module.webp
:width: 50%
:align: center

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Power Delivery (PD) Adapter with PD cable
###########################################

.. image:: ../../../_static/images/accessory-pd-adapter.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-pd-adapter.webp
:width: 40%
:align: center

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Raspberry Pi Camera Module
############################

.. image:: ../../../_static/images/accessory-rpi-camera-module.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-rpi-camera-module.webp
:width: 25%
:align: center

Expand Down Expand Up @@ -63,17 +63,17 @@ Enable Overlays In Vaaman / Axon

3. Select ``Overlays`` options in it by pressing ``enter`` key.

.. image:: ./../../../_static/images/Overlays_1.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Overlays_1.webp
:width: 50%

4. You will see Warning Page, click on ``yes`` and select ``Manage Overlays`` options.

.. image:: ./../../../_static/images/Overlays_2.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Overlays_2.webp
:width: 50%

5. Select overlays as per your camera part number ``( OV5647 / IMX219 )`` by pressing ``spacebar`` on keyboard, then select ``Ok``.

.. image:: ./../../../_static/images/Overlays_3.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Overlays_3.webp
:width: 50%

6. To return back to terminal, press the ``Esc`` key until you exit from it.
Expand All @@ -91,12 +91,12 @@ Setup

1. Attach the camera along with FPC50 15 Pin 1mm pitch cable to the CSI connector.

.. image:: ./../../../_static/images/Camera_guide_0.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Camera_guide_0.webp
:width: 50%

2. Open the Cheese application in your Ubuntu Linux operating system.

.. image:: ./../../../_static/images/Camera_1.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Camera_1.webp
:width: 50%

3. You will be shown Cheese camera interface.
Expand All @@ -105,16 +105,16 @@ Setup

5. Click on ``Preferences`` and select ``rkisp_mainpath`` in Device option.

.. image:: ./../../../_static/images/Camera_2.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Camera_2.webp
:width: 50%


.. image:: ./../../../_static/images/Camera_3.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Camera_3.webp
:width: 50%

6. Click on a webcam button in the middle of the bottom panel, or press the ``spacebar`` key, to take the photo.

.. image:: ./../../../_static/images/Camera_4.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Camera_4.webp
:width: 50%

7. There will be a short countdown, followed by a flash, and the photo will appear in the photo stream.
Expand Down Expand Up @@ -168,7 +168,7 @@ Setup

1. Attach the camera along with FPC50 15 Pin 1mm pitch cable to the CSI connector.

.. image:: ./../../../_static/images/Camera_guide_0.webp
.. image:: ./../../../_static/images/rk3399-vaaman/Camera_guide_0.webp
:width: 50%

2. Install Python if not already installed. You can download Python from the official website: `Python Downloads <https://www.python.org/downloads/>`__.
Expand Down Expand Up @@ -232,13 +232,13 @@ Setup

1. Upon running the program, the camera frame will open.

.. image:: ./../../../_static/images/python-script-camera-frame.webp
.. image:: ./../../../_static/images/rk3399-vaaman/python-script-camera-frame.webp
:alt: Image Description
:width: 650

2. Press the ``Ctrl+S`` key on your keyboard to capture an image.

.. image:: ./../../../_static/images/python-script-save-image.webp
.. image:: ./../../../_static/images/rk3399-vaaman/python-script-save-image.webp
:alt: Image Description
:width: 650

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
UART Expansion Board Module
#############################

.. image:: ../../../_static/images/accessory-uart-expansion-board.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-uart-expansion-board.webp
:width: 40%
:align: center

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
USB-C to USB-A Adapter
########################

.. image:: ../../../_static/images/accessory-usb-c-to-usb-a-adapter.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-usb-c-to-usb-a-adapter.webp
:align: center
:width: 40%

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
USB to TTL Serial Converter
#############################

.. image:: ../../../_static/images/accessory-usb-serial-module.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-usb-serial-module.webp
:width: 40%
:align: center

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Wi-Fi and Bluetooth Antenna
#############################

.. image:: ../../../_static/images/accessory-wifi-antenna.webp
.. image:: ../../../_static/images/rk3399-vaaman/accessory-wifi-antenna.webp
:width: 40%
:align: center

Expand Down
6 changes: 3 additions & 3 deletions source/vicharak_sbcs/vaaman/vaaman-fpga.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
While connecting the Programmer module, make sure to follow the
indicated color code as shown in the image.

.. image:: ../../_static/images/FPGA_JTAG_PROG.webp
.. image:: ../../_static/images/rk3399-vaaman/FPGA_JTAG_PROG.webp
:width: 50%

2. Download the BIT file
Expand All @@ -44,7 +44,7 @@
- Select the JTAG Programming mode.
- Start the programming process.

.. image:: ../../_static/images/vaaman-efinity-programmer-jtag.webp
.. image:: ../../_static/images/rk3399-vaaman/vaaman-efinity-programmer-jtag.webp
:width: 50%

Wait for the programming to complete. When the programming is complete,
Expand Down Expand Up @@ -77,7 +77,7 @@ Vaaman board blinking.

This indicates that the FPGA is configured with the bitstream.

.. image:: ../../_static/images/vaaman-fpga-user-leds.webp
.. image:: ../../_static/images/rk3399-vaaman/vaaman-fpga-user-leds.webp
:width: 50%

.. tip::
Expand Down
18 changes: 9 additions & 9 deletions source/vicharak_sbcs/vaaman/vaaman-getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Turning the Board On
| **Remove SD-card if inserted**
| This ensures the board boots from the eMMC storage.
.. image:: ../../_static/images/Power_option.webp
.. image:: ../../_static/images/rk3399-vaaman/Power_option.webp
:width: 40%
:alt: Vaaman power connection

Expand All @@ -81,7 +81,7 @@ Verify the Power LED
- **Red LED**: Indicates that Vaaman is receiving power.
- Check the red LED for immediate visual confirmation of successful power connection.

.. image:: ../../_static/images/vaaman-power-led.webp
.. image:: ../../_static/images/rk3399-vaaman/vaaman-power-led.webp
:width: 40%
:alt: Vaaman power LED

Expand All @@ -91,7 +91,7 @@ Verify the Status LED
- **Blue LED**: Blinks to indicate the completion of the booting process.
- Check the blue LED to ensure Vaaman has successfully booted and is ready for configuration.

.. image:: ../../_static/images/vaaman-blue-led.webp
.. image:: ../../_static/images/rk3399-vaaman/vaaman-blue-led.webp
:width: 40%
:alt: Vaaman status LEDs

Expand Down Expand Up @@ -140,7 +140,7 @@ For the initial setup process, we recommend connecting the Vaaman to a monitor u
- **Micro HDMI Port:** Connect Vaaman to a monitor or TV using a micro HDMI to HDMI cable or adapter.
- **Benefits:** Provides direct visual access to the graphical user interface (GUI) or command-line interface (CLI).

.. image:: ../../_static/images/vaaman-hdmi.webp
.. image:: ../../_static/images/rk3399-vaaman/vaaman-hdmi.webp
:width: 50%
:alt: Vaaman HDMI connection

Expand Down Expand Up @@ -230,7 +230,7 @@ Hardware Setup
- Pin 10 (GPIO4_C3)
- UART2DBG_RX

.. image:: ../../_static/images/vaaman-serial-uart-pins.webp
.. image:: ../../_static/images/rk3399-vaaman/vaaman-serial-uart-pins.webp
:width: 50%

Configuration
Expand Down Expand Up @@ -391,14 +391,14 @@ To access Vaaman via SSH, you can use either of the following commands:
1. Edit the ``/usr/lib/vicharak-config/conf.d/before.txt`` file.

- Add the following line:
```
``
connect-wi-fi <network name> <password>
```
``

Example:
```
``
connect-wi-fi vicharak_5g vcaa_g123
```
``

2. Reboot the system.

Expand Down
2 changes: 1 addition & 1 deletion source/vicharak_sbcs/vaaman/vaaman-home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With its compact size, the Vaaman SBC is suitable for
options`. Overall, it empowers developers to create innovative solutions
that require both processing power and hardware customization.

.. image:: ../../_static/images/Vaaman-top.webp
.. image:: ../../_static/images/rk3399-vaaman/Vaaman-top.webp
:width: 50%
:align: left

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,12 @@ git clone https://github.com/vicharak-in/rockchip-linux-kernel -b master

:::{tab-item} Using Web browser

![vicharak-linux-kernel-github](../../_static/images/vicharak-linux-kernel-github.webp)
![vicharak-linux-kernel-github](../../../../_static/images/rk3399-vaaman/vicharak-linux-kernel-github.webp)

**Follow the steps in above image.**

1. Open the [GitHub page](https://github.com/vicharak-in/rockchip-linux-kernel)
and click on the "<> Clone" button.
and click on the `< > Code` button.

2. Select the "Download ZIP" option.

Expand Down Expand Up @@ -188,11 +188,10 @@ make O=out ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j$(nproc --all)

**Upon successful compilation, confirm that you have following files.**

:::{card}

- out/arch/arm64/boot/dts/rockchip/rk3399-vaaman-linux.dtb
- out/arch/arm64/boot/Image
:::
```bash
out/arch/arm64/boot/dts/rockchip/rk3399-vaaman-linux.dtb
out/arch/arm64/boot/Image
```

:::{warning}
On Vaaman kernel version 4.4 you will not have
Expand Down Expand Up @@ -243,18 +242,20 @@ Set the specific driver that you want to build as module to `CONFIG_<XXXX>=m` in
## How to flash compiled Linux Kernel

::::{tab-set}
:::{tab-item} Copy images to boot partition

<br/>
:::{tab-item} Copy images to boot partition

### Copy the compiled kernel images to the device

<br/>

```bash

scp out/arch/arm64/boot/Image <user>@<device-ip>:~/
scp out/arch/arm64/boot/dts/rockchip/rk3399-vaaman-linux.dtb <user>@<device-ip>:~/
scp -vr out/arch/arm64/boot/dts/rockchip/overlays <user>@<device-ip>:~/

scp out/modules_rk3399_vaaman.tar.gz <user>@<device-ip>:~/

```

```{tip}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -790,7 +790,7 @@ any supported storage media (SD-Card, eMMC or NVMe) using the basic linux
utility such as `dd` or even using `Balena Etcher` tool.

```{seealso}
[How to use Balena Etcher](#write-the-image-to-the-sd-card)
[How to use Balena Etcher](../../vaaman-sdcard-boot.rst)
```

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ Vaaman's u-boot is configured for development purpose.
It will allow you 3 seconds to enter the u-boot shell before booting the kernel.
:::

3. Quickly press **CTRL+c** when you see some logs starting to appear on the
3. Quickly press ``CTRL+c`` when you see some logs starting to appear on the
console.

If you have followed the above steps successfully, you should be able to access
Expand Down Expand Up @@ -600,7 +600,7 @@ plug the SD-Card into your PC. You will see something similar to:
```

Confirm the block device using `parted /dev/sd<X>` or `lsblk`.
```


:::

Expand Down Expand Up @@ -693,7 +693,6 @@ plug the NVMe into your PC. You will see something similar to:
```

Confirm the block device using `parted /dev/nvme<X>n1` or `lsblk`.
```

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ To access Vaaman SBC through the serial interface, A USB to TTL serial cable or

:::

:::{image} ../../\_static/images/vaaman-serial-uart-pins.webp
:::{image} ../../../../_static/images/rk3399-vaaman/vaaman-serial-uart-pins.webp
:width: 50%
:::

Expand Down Expand Up @@ -144,7 +144,7 @@ Press **Ctrl+Shift+S**.
By using either of these methods, you will be able to access the configuration settings in GTK-Term,
where you can make adjustments to the port settings for your serial connection, as shown in the image below:

:::{image} ../../\_static/images/gtkterm-configuration.webp
:::{image} ../../../../_static/images/gtkterm-configuration.webp
:width: 50%
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,7 @@ DevNo=1 Vid=0x2207,Pid=0x330c,LocationID=7143 Mode=Maskrom SerialNo=

---

::::{admonition} **Linux Upgrade Tool Usage**
:class: dropdown
**Linux Upgrade Tool Usage**

```text
$ sudo ./upgrade_tool
Expand Down Expand Up @@ -248,6 +247,8 @@ Example:
```bash
sudo ./upgrade_tool uf V1.0.2311.000-vicharak-debian-bullseye-xfce-emmc.img
```
---
You will see this type of process:

```bash
[sudo] password for vicharak:
Expand Down
Loading

0 comments on commit 4dab1e7

Please sign in to comment.