feat: Add Debian-specific information to LVGL OOB docs

jsuhaas22 · jsuhaas22 · commit 657525852bcb · 2025-05-16T09:54:38.000+05:30
Presently, the LVGL OOB page is written under the assumption that the
user is using Yocto. For Debian, some of the lines have to be changed.
Therefore make those changes.

Also add the doc in Debian's tree.

Signed-off-by: Suhaas Joshi &lt;s-joshi@ti.com&gt;
diff --git a/configs/AM62LX/AM62LX_debian_toc.txt b/configs/AM62LX/AM62LX_debian_toc.txt
@@ -7,3 +7,4 @@ debian/Building_Debian_Packages
 debian/How_to_Guides/index_How_to_Guides
 linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
 debian/Demo_User_Guides/index_Demos
+system/Demo_User_Guides/TI_LVGL_Demo_User_Guide
diff --git a/source/debian/Demo_User_Guides/index_Demos.rst b/source/debian/Demo_User_Guides/index_Demos.rst
@@ -10,4 +10,4 @@ The default Debian image supports the following demo-applications
    :maxdepth: 1
 
    /debian/Demo_User_Guides/Chromium_Browser
-
+   /system/Demo_User_Guides/TI_LVGL_Demo_User_Guide
diff --git a/source/devices/AM62LX/debian/Getting_Started_Guide.rst b/source/devices/AM62LX/debian/Getting_Started_Guide.rst
@@ -24,6 +24,8 @@ In addition to the EVM itself, the following hardware is needed:
 6. USB mouse and Keyboard (For controlling the UI)
 7. Ethernet cable (For network access)
 
+.. _processor-sdk-debian-create-sd-card:
+
 Create SD Card using balenaEtcher
 ---------------------------------
 
diff --git a/source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst b/source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst
@@ -69,13 +69,43 @@ Hardware Prerequisites
 Launching the TI LVGL Demo
 **************************
 
-The demo will auto launch upon Linux booting on the EVM. Follow the below instructions to flash the SD card:
+.. ifconfig:: CONFIG_sdk in ('SITARA')
 
-1. Flash an SD card with the :file:`tisdk-default-image`. User can download the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|.
+   The demo will auto launch upon Linux booting on the EVM. Follow the below instructions to flash the SD card:
+
+   1. Flash an SD card with the :file:`tisdk-default-image`. User can download the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|.
    Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.
 
-2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power on the EVM.
-   The TI LVGL Demo will launch automatically when the device is fully booted.
+   .. ifconfig:: CONFIG_part_variant not in ('AM62LX')
+
+      2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, and power on the EVM.
+      The TI LVGL Demo will launch automatically when the device is fully booted.
+
+   .. ifconfig:: CONFIG_part_variant in ('AM62LX')
+
+      2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power on the EVM.
+      The TI LVGL Demo will launch automatically when the device is fully booted.
+
+.. ifconfig:: CONFIG_sdk in ('DebianSDK')
+
+   Upon booting the EVM, Weston is launched automatically. To launch the LVGL demo, refer the following
+   instructions:
+
+   1. Flash an SD card with the :file:`tisdk-debian-trixie` wic image. User can download the wic image from |__SDK_DOWNLOAD_URL__|.
+   Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-debian-create-sd-card>`.
+
+   .. ifconfig:: CONFIG_sdk not in ('AM62LX')
+
+      2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power the EVM on.
+
+   .. ifconfig:: CONFIG_sdk in ('AM62LX')
+
+      2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power the EVM on.
+
+   3. Weston is launched on boot. Shut it down with `systemctl stop weston`.
+
+   4. Launch the demo by typing `/usr/bin/lvglsim` into the UART command prompt.
+
 
 **********************
 Using the TI LVGL Demo
@@ -176,16 +206,29 @@ To launch the Smart Home HMI demo, click on the `Smart Home` widget in the apps
 
    .. note::
 
-      By default CC33xx is configured at boot, so here are the steps that can be followed to enable it:
+       By default CC33xx is configured at boot, so here are the steps that can be followed to enable it:
+
+       .. ifconfig:: CONFIG_sdk in ('SITARA')
+
+         .. code-block:: console
+
+             root@<machine>:~ systemctl stop ti-lvgl-demo
+             root@<machine>:~  cd /usr/share/cc33xx
+             root@<machine>:~  ./sta_start.sh
+             root@<machine>:~  ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
+             root@<machine>:~  udhcpc -i wlan0
+             root@<machine>:~  systemctl start ti-lvgl-demo
 
-      .. code-block:: console
+      .. ifconfig:: CONFIG_sdk in ('DebianSDK')
 
-         $ systemctl stop ti-lvgl-demo
-         $ cd /usr/share/cc33xx
-         $ ./sta_start.sh
-         $ ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
-         $ udhcpc -i wlan0
-         $ systemctl start ti-lvgl-demo
+           .. code-block:: console
+
+             root@<machine>:~  systemctl stop ti-lvgl-demo
+             root@<machine>:~  cd /usr/share/cc33xx
+             root@<machine>:~  bash ./sta_start.sh
+             root@<machine>:~  bash ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
+             root@<machine>:~  udhcpc -i wlan0
+             root@<machine>:~  systemctl start ti-lvgl-demo
 
       For more details on how to enable CC33xx and connect to WiFi, visit :ref:`How to Enable M.2-CC33x1 in Linux <enable_m2cc3301>`
 
@@ -290,11 +333,22 @@ This widget contains a slide-show on Application Processor Security for AM6X dev
 Building the TI LVGL Demo from Sources
 **************************************
 
-The TI LVGL Demo is enabled in :file:`tisdk-default-image` yocto filesystem for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
-the binary itself does not have asset images and slides built in it. :file:`tisdk-default-image` contains the required assets within
-:file:`/usr/share/ti-lvgl-demo/*`. Place any additional assets here while making any modifications. Yocto recipe for
-building this demo can be found at
-`github: ti-lvgl-demo.bb <https://github.com/TexasInstruments/meta-tisdk/blob/scarthgap/recipes-demos/ti-lvgl-demo/ti-lvgl-demo.bb>`__
+.. ifconfig:: CONFIG_sdk in ('SITARA')
+
+    The TI LVGL Demo is enabled in :file:`tisdk-default-image` yocto filesystem for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
+    the binary itself does not have asset images and slides built in it. :file:`tisdk-default-image` contains the required assets within
+    :file:`/usr/share/ti-lvgl-demo/`. Place any additional assets here while making any modifications. Yocto recipe for
+    building this demo can be found at
+    `github: ti-lvgl-demo.bb <https://github.com/TexasInstruments/meta-tisdk/blob/scarthgap/recipes-demos/ti-lvgl-demo/ti-lvgl-demo.bb>`__
+
+.. ifconfig:: CONFIG_sdk in ('DebianSDK')
+
+    The TI LVGL Demo is packaged in :file:`tisdk-debian-trixie` wic image for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
+    the binary itself does not have asset images and slides built in it. :file:`tisdk-debian-trixie` contains the required assets within
+    :file:`/usr/share/ti-lvgl-demo/`. Place any additional assets here while making any modifications. Debian package
+    files for building this demo can be found at
+    `github: ti-lvgl-demo debian package <https://github.com/TexasInstruments/debian-repos/blob/master/ti-lvgl-demo/suite/trixie/debian/>`__
+
 
 The source code is available at `TI LVGL Demo <https://github.com/TexasInstruments/ti-lvgl-demo.git/>`__ and can be re-compiled with the
 following steps:
