Skip to content

Commit 1cee062

Browse files
authored
Merge pull request #509 from arduino/martab1994-patch-5
Update content.md
2 parents 836edec + 66dd8a1 commit 1cee062

File tree

1 file changed

+15
-15
lines changed
  • content/hardware/04.pro/boards/portenta-h7/tutorials/lauterbach-debugger

1 file changed

+15
-15
lines changed

content/hardware/04.pro/boards/portenta-h7/tutorials/lauterbach-debugger/content.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ This tutorial will show you how to use the Lauterbach TRACE32 GDB front-end debu
3434

3535
### TRACE32 GDB Front End Debugger
3636

37-
In this tutorial you will load an application on the Portenta H7 board which includes the Monitor for Remote Inspection (MRI). This is a GDB compatible serial monitor which is included in the ThreadDebug sketch in the Arduino IDE Examples for Portenta H7 (M7 core) and in all examples in the TRACE32 demo directory of the TRACE32 installation. Throughout this document the **double-tilde (~~)** is used as a place holder for the directory where you unzipped the TRACE32 software.
37+
In this tutorial you will load an application on the Portenta H7 board which includes the Monitor for Remote Inspection (MRI). This is a GDB compatible Serial Monitor which is included in the ThreadDebug sketch in the Arduino IDE Examples for Portenta H7 (M7 core) and in all examples in the TRACE32 demo directory of the TRACE32 installation. Throughout this document the **double-tilde (~~)** is used as a place holder for the directory where you unzipped the TRACE32 software.
3838

39-
***This tutorial assumes that you have already installed the Arduino IDE or Arduino Pro IDE and configured it to support the Portenta H7 board. Please refer to [Setting Up Portenta H7 For Arduino](setting-up-portenta) before you proceed.***
39+
***This tutorial assumes that you have already installed the Arduino IDE and configured it to support the Portenta H7 board. Please refer to [Setting Up Portenta H7 For Arduino](https://docs.arduino.cc/tutorials/portenta-h7/setting-up-portenta) before you proceed.***
4040

4141
### 1. Downloading the TRACE32 Debugger
4242

@@ -60,7 +60,7 @@ There are two alternative ways to detect the board serial number:
6060

6161
![Portenta's serial number can be displayed in the Arduino IDE using the "Get Board Info" command](assets/por_ard_trace32_board_info.png)
6262

63-
***If you only see a 16 character (64-bit) long serial number, then you need to update your Arduino IDE and the "Arduino mbed-enabled Boards" core from the boards manager in the IDE. Details of how to do this can be found on the Arduino website. Also, make sure your Portenta H7 has the [latest bootloader](https://www.arduino.cc/pro/tutorials/portenta-h7/updating-the-bootloader) installed.***
63+
***If you only see a 16 character (64-bit) long serial number, then you need to update your Arduino IDE and the "Arduino mbed-enabled Boards" core from the boards manager in the IDE. Details on how to do this can be found on the Arduino website. Also, make sure your Portenta H7 has the [latest bootloader](https://docs.arduino.cc/tutorials/portenta-h7/updating-the-bootloader) installed.***
6464

6565
- Use the TRACE32 debugger. Check section "3. Start the TRACE32 Debugger" on how to start it. Click the menu item "Board S/N and License State". Your board's serial number will be printed in the AREA window and a dialog LICENSE.state will be opened.
6666

@@ -79,7 +79,7 @@ When you receive the email containing your license key, follow the instructions
7979

8080
### 3. Starting the TRACE32 Debugger
8181

82-
To use the debugger launch the appropriate executable for your host operating system. The executables can be found in the corresponding sub-directory for your operating system:
82+
To use the debugger, launch the appropriate executable for your host operating system. The executables can be found in the corresponding sub-directory for your operating system:
8383

8484
`~~/bin/windows` for 32-bit Windows hosts
8585

@@ -101,11 +101,11 @@ On Windows systems, the TRACE32 start-up script will automatically search for th
101101

102102
On Linux systems, you will need to edit the system-settings.cmm file to manually add the serial port to connect to the Portenta H7 board. This is a text file and can be opened with your favorite text editor. Edit the line that defines &GDBPORT to refer to the serial port, for example: `&GDBPORT="/dev/ttyACM0"`. This must be done **before** you start the TRACE32 software. After changing the port you can start the TRACE32 debugger or re-start it in case it was open while you made the changes.
103103

104-
***The manual port setting is also useful for Windows systems where you have multiple Portenta H7 boards connected, and you want to select a specific board to be used by TRACE32 for debugging. The automatic port selection is disabled when a &GDBPORT definition is found in `system-settings.cmm`.***
104+
***The manual port setting is also useful for Windows systems where you have multiple Portenta H7 boards connected and you want to select a specific board to be used by TRACE32 for debugging. The automatic port selection is disabled when a &GDBPORT definition is found in `system-settings.cmm`.***
105105

106106
### 4. Running Your First Demo
107107

108-
A number of pre-built demo programs are available.They can be accessed from the "Portenta H7 Demos" menu. The following instructions relate to the T32ThreadDebug example. However, the other examples follow a similar pattern.
108+
A number of pre-built demo programs are available. They can be accessed from the "Portenta H7 Demos" menu. The following instructions relate to the T32ThreadDebug example. However, the other examples follow a similar pattern.
109109

110110
The demo directory already includes the symbolic file (.elf) for debugging and the binary file (.bin) for Flash programming.
111111

@@ -117,7 +117,7 @@ Select "T32ThreadDebug" from the "Portenta H7 Demos" menu and you will be presen
117117

118118
![Elf File Selection](assets/por_ard_trace32_elf_file_selection.png)
119119

120-
In this dialog you can select which variant of the Arduino IDE you would like to use to source ELF files or if you want to use the current directory. To follow this tutorial please select "current dir".
120+
In this dialog, you can select which variant of the Arduino IDE you would like to use to source ELF files or if you want to use the current directory. To follow this tutorial please select "current dir".
121121

122122
The list to the right of the "Options" selection should then become populated with a number of available ELF files for downloading and debugging. Select the one you want with a double click. In this case select "T32ThreadDebug.ino.elf". This will also show file attributes such as date, time and size. To select an ELF file from a custom directory, click the "File" button underneath the "User's choice" field and browse for the desired ELF file. You can opt for changing the behavior of this script the next time it is executed.
123123

@@ -143,11 +143,11 @@ Take a look at the readme.txt file inside the demo directory for further informa
143143

144144
The provided demos or another project of your choice can be edited, compiled and flashed with the Arduino IDE. You can open for example the T32ThreadDebug.ino file with Arduino IDE, build and flash it. Flashing is also possible with TRACE32.
145145

146-
***IMPORTANT: If you chose to program the Flash from within the Classic Arduino IDE, do not close the IDE after programming; leave it open. This is very important because if you close the IDE, it cleans up the temporary build directory which includes the ELF file.***
146+
***IMPORTANT: If you choose to program the Flash from within the Classic Arduino IDE, do not close the IDE after programming; leave it open. This is very important because, if you close the IDE, it cleans up the temporary build directory which includes the ELF file.***
147147

148148
The demo directory contains a startup script which will copy the ELF file and the binary file in the current working directory. After the startup script was run you can safely close the Classic Arduino IDE if you don't need it anymore.
149149

150-
When you're done with flashing your application to the board you can switch back to TRACE32. Select the type of Arduino IDE (Classic or Pro). If an ELF file is found double-click to select it, then select "Load debug symbols (program is already in flash)", and click "OK".
150+
When you are done with flashing your application to the board, you can switch back to TRACE32. Select the type of Arduino IDE. If an ELF file is found, double-click to select it, then select "Load debug symbols (program is already in flash)" and click "OK".
151151

152152
### Startup Script
153153

@@ -177,7 +177,7 @@ For each demo the corresponding start.cmm script comes with a predefined window
177177

178178
## Conclusion
179179

180-
In this tutorial you learned how to acquire a free version of the TRACE32 GDB Front End debugger, fully licensed for Portenta H7 for one year. You learned how to start the debugger and debug some ready-to-run demos. Furthermore you learned how to debug an application compiled with the classic Arduino IDE or the Arduino Pro IDE.
180+
In this tutorial you learned how to acquire a free version of the TRACE32 GDB Front End debugger, fully licensed for Portenta H7 for one year. You learned how to start the debugger and debug some ready-to-run demos. Furthermore, you learned how to debug an application compiled with the classic Arduino IDE.
181181

182182
### Next Steps
183183
Lauterbach also provides hardware-based debug & trace tools. To learn more about them please visit:
@@ -192,7 +192,7 @@ Lauterbach also provides hardware-based debug & trace tools. To learn more about
192192

193193
- Update Arduino IDE to the latest version available
194194
- Update **Arduino mbed-enabled Boards** core from Arduino IDE menu: **Tools > Board > Boards Manager**
195-
- [Update the Portenta's bootloader using the instructions](https://www.arduino.cc/pro/tutorials/portenta-h7/updating-the-bootloader).
195+
- [Update the Portenta's bootloader using the instructions](https://docs.arduino.cc/tutorials/portenta-h7/updating-the-bootloader).
196196

197197
### Error Message in AREA View: 'No More Arguments Expected'
198198

@@ -215,19 +215,19 @@ In case the debugger encounters any issues while connecting to the Portenta, try
215215

216216
### Issues While Starting TRACE32 on Linux
217217

218-
- The TRACE32 executable for Linux requires the Qt libraries. Please verify that one of the following versions of Qt is installed:
218+
- The TRACE32 executable for Linux requires the Qt libraries. Please verify that one of the following versions of Qt is installed:
219219
- Qt4 >= 4.6.2 (Linux 32 bit or 64 bit)
220220
- or Qt5 >= 5.9 (Linux 64 bit)
221221

222-
On Ubuntu Linux for example you can install the Qt5 libraries using apt-get: `sudo apt-get install qt5-default`
222+
On Ubuntu Linux, for example, you can install the Qt5 libraries using apt-get: `sudo apt-get install qt5-default`
223223

224224
### Issues With the GDB Serial Port on Host Linux
225225

226-
The user running the TRACE32 executable on Linux must have the permission to access serial devices. For example in Ubuntu a temporary permission can be set as follows:
226+
The user running the TRACE32 executable on Linux must have the permission to access serial devices. For example, in Ubuntu a temporary permission can be set as follows:
227227

228228
`sudo chown :username /dev/devicename`
229229

230-
You can also set a permanent permission adding the user to the "dialout" group. For example in Ubuntu:
230+
You can also set a permanent permission adding the user to the "dialout" group. For example, in Ubuntu:
231231

232232
`sudo adduser username dialout`
233233

0 commit comments

Comments
 (0)