Latest revision as of 17:23, 28 April 2023

Warning: This page is designed to be used with a 'release' URL parameter.

This page is using the default release mx8mm-debian-bullseye-5.4-2.1.x-v1.3.
To view this page for a specific Variscite SoM and software release, please follow these steps:

Visit variwiki.com
Select your SoM
Select the software release

DART-MX8M-MINI - Debian Programming with Eclipse

Overview

This guide describes how to use Eclipse to develop and debug applications on the DART-MX8M-MINI.

Create your rootfs with Eclipse debug support

To enable debug support on the target, make sure to have the following packages installed:

gdbserver
openssh-sftp-server

Info:

The Eclipse IDE supports gdbserver and tcf-agent; both are servers/agents to enable the debug capabilities on the target.

In this guide, we will focus on Remote Debugging with the Eclipse IDE using gdbserver.

The packages can be installed by running the following commands on the target:

$ apt-get update && apt-get -y upgrade
$ apt-get -y install gdbserver openssh-sftp-server

Note: The package openssh-sftp-server may possibly already be installed.

If you want to learn how to add the packages at compile time, please refer to Adding Debian packages.

Setup Host Computer Environment

Please follow the steps below to prepare a fresh Ubuntu 20.04 installation for Eclipse debugging:

Install Dependencies

$ sudo apt-get update
$ sudo apt-get -y install build-essential gdb gdb-multiarch git default-jre

Install Debian Toolchain

To install the toolchain, follow the Debian Toolchain installation guide.

Download Eclipse

Download Eclipse 2021-06 from here: https://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/2021-06/R/eclipse-cpp-2021-06-R-linux-gtk-x86_64.tar.gz
Run the following command to unpack and install the downloaded Eclipse IDE tarball into a clean directory using the default name eclipse:

$ cd ~
$ tar -xf ~/Downloads/eclipse-cpp-2021-06-R-linux-gtk-x86_64.tar.gz

Create and run a simple application

Run the Eclipse IDE

Run the Eclipse IDE with the following commands:

$ cd eclipse
$ ./eclipse

Select a new workspace (you can just click OK).

Create the Project

You can create different types of projects: C Managed Build, CMake, Meson, or Makefile. This section describes how to create "C Managed Build" projects from within the Eclipse IDE. To create a new project from a "Hello World" template and then display the source code, follow these steps:

File->New->C/C++ Project
Select C Managed Build and click Next.
Enter a name for the project under the Project name field. Do not use hyphens as part of the name.
Select Hello World ANSI C Project.
Select Cross GCC toolchain

Click Next.
Add information in the Author field and make sure the License field is correct and click Next.
Accept the default Debug/Release configurations and click Next.
Enter aarch64-linux-gnu- under Cross compiler prefix
Enter ${HOME}/debian_imx8mm-var-dart/toolchain/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/bin under Cross compiler path

Click "Finish".
Click on "Workbench".
You should now be in the C/C++ perspective. The left-hand navigation pane shows your project. You can display your source by double clicking the project's source file.

Configure Cross Compiler

The sysroot flag must be added to the linker and C/C++ compilers within Eclipse:

Right click on the project and select Properties
Under C/C++ Build, select Settings

Add the following include path to Cross GCC Compiler->Includes

${HOME}/debian_imx8mm-var-dart/toolchain/sysroot/usr/include

C/C++ Build -> Settings -> Cross GCC Compiler -> Includes

Append the following to Cross GCC Compiler -> Miscellaneous -> Other Flags:

--sysroot=${HOME}/debian_imx8mm-var-dart/toolchain/sysroot

C/C++ Build -> Settings -> Cross GCC Compiler -> Miscellaneous

Append the following to Cross GCC Linker -> Miscellaneous -> Other Flags:

--sysroot=${HOME}/debian_imx8mm-var-dart/toolchain/sysroot

C/C++ Build -> Settings -> Cross GCC Linker -> Miscellaneous

Configure Remote Debugging

The target should be connected to the network via Ethernet or WIFI.
Use the "ifconfig" command on the target to get its IP address.
From Eclipse:

Click Run->Debug Configurations...
Double click on C/C++ Remote Application.
In the Main tab, section C/C++ Application, type Debug/hello-world.
Next, click on New... to create a new connection.

Select SSH for the connection type and click OK.
Enter the Target IP Address.
Enter root for the user.
Change to "Password based authentication" and enter password 'root'.
Click Finish
Type "/root/hello-world" in the Remote Absolute File Path for C/C++ Application field
Click on the Debugger tab
Enter aarch64-linux-gnu-gdb in the GDB debugger field

Click Apply and Close to finish configuring the debugger

Remote debug

Follow the below steps to remotely debug your application on the DART-MX8M-MINI.

Use the keyboard shortcut ctrl-b to rebuild the application.
Click the bug icon in the toolbar and select "hello-world debug" (or whichever name you supplied in the previous step)
Follow the prompt to switch to the Debug perspective

You can now run and debug your program via eclipse. The actual program execution is done on the target, and the output is seen on the Remote Shell on Eclipse.

@@ Line 2: / Line 2: @@
 --> {{INIT_RELEASE_PARAM|mx8mm-debian-bullseye-5.4-2.1.x-v1.3}} <!--
 --> {{#lst:Debian_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
---> {{PageHeader|{{#var:HARDWARE_NAME}} - Debian Programming with Eclipse}} {{DocImage|category1={{#var:HARDWARE_NAME}}|category2=Yocto}}
+--> {{PageHeader|{{#var:HARDWARE_NAME}} - Debian Programming with Eclipse}} {{DocImage|category1={{#var:HARDWARE_NAME}}|category2=Debian}}
 __toc__
@@ Line 18: / Line 18: @@
 In this guide, we will focus on Remote Debugging with the Eclipse IDE using '''gdbserver'''.<br>|info}}
-The packages can be installed at runtime or compile-time, as shown below:
+The packages can be installed by running the following commands on the target:
-* '''Add required packages at runtime'''<br>
+  $ apt-get update && apt-get -y upgrade
-Login to your target and run the commands:
-  $ apt-get update
   $ apt-get -y install gdbserver openssh-sftp-server <!--
 -->{{Note|'''Note:''' The package '''openssh-sftp-server''' may possibly already be installed.|info}}
-* '''Add required packages at compile-time'''<br>
-Use the variable 'G_USER_PACKAGES' in the build script to add further packages to your image
+If you want to learn how to add the packages at compile time, please refer to {{Varlink2|Adding Debian packages|{{#var:RELEASE_LINK}}}}.
-For example:
- #### user rootfs packages ####
- readonly G_USER_PACKAGES=" \
- 	gdbserver \
- 	openssh-sftp-server \
- 	"
-''File: {{#var:BUILD_FOLDER}}/var_make_debian.sh''
-and build the image, according to the page {{Varlink2|Debian Build Release|{{#var:RELEASE_LINK}}}}.
-Please also refer to the page {{Varlink2|Adding Debian packages|{{#var:RELEASE_LINK}}}} if you want to learn more about adding packages to a Debian image.
 = Setup Host Computer Environment =
@@ Line 55: / Line 36: @@
 == Install Debian Toolchain ==
-To cross-compile your application on the host with the Eclipse IDE following basic components are needed:
-* cross compiler ({{#var:TOOLCHAIN}})
-* target's rootfs (standard include at /usr/include and libraries at /usr/lib)
-<br>
-Both of them are provided by the Debian build script. Once you went through the {{Varlink2|Debian Build Release|{{#var:RELEASE_LINK}}}} guide you should be able to find:
-* The cross compiler at {{#var:BUILD_FOLDER}}/toolchain
-* And the target's rootfs at {{#var:BUILD_FOLDER}}/rootfs
-{{Note|'''Note''': It's highly recommended to keep the host-side used rootfs for compiling/linking consistent with the target rootfs.|info}}
+To install the toolchain, follow the {{Varlink2|Debian Toolchain installation|{{#var:RELEASE_LINK}}}} guide.
 == Download Eclipse ==
@@ Line 102: / Line 74: @@
 * Enter <code>${HOME}/{{#var:BUILD_FOLDER_NAME}}/toolchain/{{#var:TOOLCHAIN}}/bin</code> under ''Cross compiler path''
-[[File:Prj1_compiler_V2.png]]
+[[File:eclipse_compiler_debian.png|800px]]
 * Click "Finish".
@@ Line 118: / Line 90: @@
 * Add the following include path to ''Cross GCC Compiler->Includes''
-  ${HOME}/{{#var:BUILD_FOLDER_NAME}}/rootfs/usr/include
+  ${HOME}/{{#var:BUILD_FOLDER_NAME}}/toolchain/sysroot/usr/include
 ''C/C++ Build -> Settings -> Cross GCC Compiler -> Includes''
-[[File:Toolchain_include.png]]
+[[File:eclipse_toolchain_include_debian.png]]
 * Append the following to ''Cross GCC Compiler -> Miscellaneous -> Other Flags'':
-  --sysroot=${HOME}/{{#var:BUILD_FOLDER_NAME}}/rootfs
+  --sysroot=${HOME}/{{#var:BUILD_FOLDER_NAME}}/toolchain/sysroot
 ''C/C++ Build -> Settings -> Cross GCC Compiler -> Miscellaneous''
-[[File:Toolchain_settings.png]]
+[[File:eclipse_toolchain_settings_debian.png]]
 * Append the following to ''Cross GCC Linker -> Miscellaneous -> Other Flags'':
-  --sysroot=${HOME}/{{#var:BUILD_FOLDER_NAME}}/rootfs
+  --sysroot=${HOME}/{{#var:BUILD_FOLDER_NAME}}/toolchain/sysroot
 ''C/C++ Build -> Settings -> Cross GCC Linker -> Miscellaneous''
-[[File:Toolchain_settings_2.png]]
+[[File:eclipse_toolchain_settings_2_debian.png]]
 == Configure Remote Debugging ==
-Using the console of your target set a password with "passwd" command. choose a simple one named "root".<br>
 The target should be connected to the network via Ethernet or WIFI.<br>
 Use the "ifconfig" command on the target to get its IP address.<br>
@@ Line 147: / Line 118: @@
 * Click Run->Debug Configurations...
 * Double click on ''C/C++ Remote Application''.
-* In the ''Main'' tab, click on ''New...'' to create a new connection.
+* In the ''Main'' tab, section ''C/C++ Application'', type <code>Debug/hello-world</code>.
+* Next, click on ''New...'' to create a new connection.
-[[File:GDB_Conn.png]]
+[[File: GDB_Conn_V2.png]]
 * Select ''SSH'' for the connection type and click ''OK''.
 * Enter the Target IP Address.
 * Enter ''root'' for the user.
-* Change to "Password based authentication" and enter password configured in previous step.
+* Change to "Password based authentication" and enter password 'root'.
 * Click ''Finish''
-* Type "/home/root/hello-world" in the ''Remote Absolute File Path for C/C++ Application'' field
+* Type "/root/hello-world" in the ''Remote Absolute File Path for C/C++ Application'' field
 * Click on the ''Debugger'' tab
-* Enter  <code>{{#var:TOOLCHAIN_TYPE}}-gdb</code> in the ''GDB debugger'' field
+* Enter  <code>{{#var:CROSS_COMPILE}}gdb</code> in the ''GDB debugger'' field
-[[File:GDB_Conn_2.png]]
+[[File:eclipse_gdb_conn_debian.png]]
 * Click ''Apply'' and ''Close'' to finish configuring the debugger

Debian Programming with Eclipse: Difference between revisions