Visual Studio Code: Difference between revisions
m (Tchan moved page Visual Studio Code Debugging to Visual Studio Code: rename (removal of "debugging")) |
No edit summary |
||
(39 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
This is a guide to setup your Visual Studio Code project with debugging support on both real | This is a guide to setup your [https://code.visualstudio.com/ Visual Studio Code] project with debugging support on both on a real Dreamcast and with an emulator. | ||
== Prerequisites == | == Prerequisites == | ||
To start with, this tutorial makes the following assumptions: | To start with, this tutorial makes the following assumptions: | ||
* You have already installed and [https://dreamcast.wiki/Getting_Started_with_Dreamcast_development set up your KallistiOS development environment] | * You have already installed and [https://dreamcast.wiki/Getting_Started_with_Dreamcast_development set up your KallistiOS development environment]] | ||
# if you want to be able to debug, be sure to compile gdb as specified on that page | # if you want to be able to debug, be sure to compile gdb as specified on that page | ||
* You have already downloaded and installed [https://code.visualstudio.com/ Visual Studio Code] (version 1.78.2 was used for this tutorial) | * You have already downloaded and installed [https://code.visualstudio.com/ Visual Studio Code] (version 1.78.2 was used for this tutorial) | ||
Line 11: | Line 11: | ||
* (optional but recommended) To keep your configuration settings, plugins, ... specific to Dreamcast projects only: | * (optional but recommended) To keep your configuration settings, plugins, ... specific to Dreamcast projects only: | ||
# Create a "Profile" (Menu: File-Preferences-Profiles) called "Dreamcast" | # Create a "Profile" (Menu: File-Preferences-Profiles) called "Dreamcast" | ||
* | * Install the following extensions: (Menu: View-Extensions) | ||
# [https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools C/C++] from Microsoft | # Required: | ||
# [https://marketplace.visualstudio.com/items?itemName=ms-vscode.makefile-tools Makefile Tools] from Microsoft | ## [https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools C/C++] from Microsoft | ||
# Required only if you are using WSL (Windows Subsystem for Linux): | |||
## [https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl WSL from Microsoft] | |||
# (Not recommended at this moment:) | |||
## ([https://marketplace.visualstudio.com/items?itemName=ms-vscode.makefile-tools Makefile Tools] from Microsoft: the current version (June 2023) is not really adapted for remote debugging) | |||
== Setup per Project == | == Setup per Project == | ||
=== Compilation === | === Compilation === | ||
==== Preparation ==== | |||
(all the following steps happen in Visual Studio Code) | (all the following steps happen in Visual Studio Code) | ||
# Open the folder containing your project | # Open the folder containing your project - eg: /opt/toolchains/dc/kos/examples/dreamcast/2ndmix: | ||
##If you are using WSL: | |||
###"F1" - "Connect To WSL" | |||
##Menu: File-Open Folder... | |||
# (if you are using Profiles) Make sure that the "Dreamcast" profile is selected (Menu: File-Preferences-Profiles) | # (if you are using Profiles) Make sure that the "Dreamcast" profile is selected (Menu: File-Preferences-Profiles) | ||
#If you are using WSL, check that the C/C++ extension is correctly installed for WSL - if you get a warning like "install in WSL: Ubuntu", do so. | |||
# Create a new subfolder ".vscode" | # Create a new subfolder ".vscode" | ||
# insert the following files in the ".vscode" subfolder: | # insert the following files in the '''".vscode" subfolder''': | ||
* '''kos_environ.sh''' | |||
* kos_environ.sh | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
#!/bin/bash | #!/bin/bash | ||
Line 38: | Line 40: | ||
source /opt/toolchains/dc/kos/environ.sh | source /opt/toolchains/dc/kos/environ.sh | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* | |||
* '''kos_make.sh''' | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
#!/bin/bash | |||
#set the KOS environtment variables | |||
source /opt/toolchains/dc/kos/environ.sh | |||
make | |||
exit | |||
</syntaxhighlight> | |||
= | * '''settings.json''' | ||
* | <syntaxhighlight lang="json"> | ||
{ | |||
"C_Cpp.default.includePath": [ | |||
"${workspaceFolder}/**", | |||
"/opt/toolchains/dc/kos/include/**", | |||
"/opt/toolchains/dc/kos/kernel/arch/dreamcast/include/**", | |||
"/opt/toolchains/dc/kos/addons/include/**", | |||
"/opt/toolchains/dc/kos-ports/include/**", | |||
"/opt/toolchains/dc/kos-ports/*/include/**" | |||
], | |||
"C_Cpp.default.defines": [ | |||
"_arch_dreamcast" | |||
], | |||
"C_Cpp.default.compilerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gcc", | |||
"C_Cpp.default.cStandard": "c11", | |||
"C_Cpp.default.cppStandard": "c++17", | |||
"C_Cpp.default.intelliSenseMode": "", | |||
"terminal.integrated.defaultProfile.linux": "kos-bash", | |||
"terminal.integrated.profiles.linux": { | |||
"kos-bash": { | |||
"path": "/usr/bin/bash", | |||
"args": ["--init-file", "${workspaceFolder}/.vscode/kos_environ.sh" ], | |||
"overrideName": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
(TODO: to be tested for Mac/OSX: probably needs the 2 lines terminal.integrated.*.linux replaced with terminal.integrated.*.osx) | |||
* '''tasks.json''' | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
Line 87: | Line 92: | ||
{ | { | ||
"label": "Build", | "label": "Build", | ||
"type": " | "type": "process", | ||
"command": " | "command": "bash", | ||
"args": [ | "args": [ | ||
" | "--init-file", "${workspaceFolder}/.vscode/kos_make.sh" | ||
], | ], | ||
"group": { | "group": { | ||
Line 101: | Line 106: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | The result should look like this: | ||
{| | |||
| [[File:Vscode cfg files.png|thumb]] | |||
|} | |||
At this point, you should be able to compile applications for the Dreamcast! | |||
==== Compilation ==== | |||
You can compile via 2 ways: | |||
# via the VSCode [https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette Command Palette] - "Tasks: Run Build Task", or | |||
# by opening a "kos-bash" terminal (Menu: View-Terminal if not visible yet, then click on the "+" to see the terminals to choose from, and select "kos-bash"), and typing "make" | |||
In both cases, the compilation should generate an executable file, ending with .elf | |||
Note: "kos-bash" is a bash shell with the "source /opt/toolchains/dc/kos/environ.sh" already executed for you. It should be your default shell in VSCode as long as you used the settings.json mentioned above. | |||
==== Running a program ==== | |||
For this, we will use the "make run" command that you can find in many (all?) Makefiles of the KallistiOs project, to send and run the program on a real dreamcast: | |||
* Typically, one of the following tools is used to run a program for the Dreamcast: | |||
# on a real Dreamcast: | |||
##via an ethernet cable & a [https://dreamcast.wiki/Broadband_adapter Broadband] (BBA) or [https://dreamcast.wiki/LAN_adapter LAN] adapter: '''[https://dreamcast.wiki/Dcload-ip dcload-ip]''' | |||
## via a [https://dreamcast.wiki/Coder%27s_cable coder's cable] & the serial port of the Dreamcast: '''[https://dreamcast.wiki/Dcload-serial dcload-serial]''' | |||
# on an emulator, like lxdream-nitro | |||
* Make sure that the '''KOS_LOADER''' variable in '''/opt/toolchains/dc/kos/environ.sh''' is configured correctly: | |||
# for '''dcload-ip''' (example if the IP of the Dreamcast is 192.168.1.210): | |||
<syntaxhighlight lang="bash"> | |||
export KOS_LOADER="dc-tool-ip -t 192.168.1.210 -x" | |||
</syntaxhighlight> | |||
# for '''dcload-serial''' (example if the Dreamcast is on serial port /dev/ttyS0): | |||
<syntaxhighlight lang="bash"> | |||
export KOS_LOADER="dc-tool-ser -t /dev/ttyS0 -x" | |||
</syntaxhighlight> | |||
# for '''the emulator''' (example with lxdream-nitro): | |||
<syntaxhighlight lang="bash"> | |||
export KOS_LOADER="/opt/toolchains/dc/lxdream-nitro/builddir/lxdream-nitro -e" | |||
</syntaxhighlight> | |||
* If want to run it on a real Dreamcast, power it on with the dcload disc loaded, and wait for the blue screen | |||
* Open a "kos-bash" terminal, and type: make run | |||
* The program will be running on your Dreamcast or on the emulator ! | |||
* (If you ran the 2ndmix example, you can press the START button on the Dreamcast pad to exit) | |||
* Note: be sure to not have a gdb_init(); line added in your code when you only want to run a program & not debug it. | |||
=== Debugging === | |||
==== Preparation ==== | |||
* Make sure that you compiled gdb for the Dreamcast, ie '''/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb''' should exist (cfr prerequisites) | |||
* Debugging in Visual Studio Code is configured in a '''.vscode/launch.json''' file. You can add as many debugging configurations as you want inside that launch.json file, eg 1 for debugging on a dreamcast, 1 for debugging on an emulator, ... | |||
# insert the following files in the '''".vscode" subfolder''': | |||
* '''launch.json''' (example with the IP of the Dreamcast = 192.168.1.210 for the BBA/LAN or /dev/ttyS0 for the serial cable): | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"version": "0.2.0", | "version": "0.2.0", | ||
"configurations": [ | "configurations": [ | ||
{ | |||
// | "name": "BBA_LAN", | ||
"type": "cppdbg", | |||
"request": "launch", | |||
"preLaunchTask": "Build", | |||
"cwd": "${workspaceFolder}", | |||
"program": "${workspaceFolder}/${workspaceFolderBasename}.elf", | |||
//"program": "${workspaceFolder}/2ndmix.elf", | |||
"MIMode": "gdb", | |||
"miDebuggerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb", | |||
"miDebuggerServerAddress":"localhost:2159",//common misconception: we connect to the gdb server offered by dc-tool-ip, NOT to the Dreamcast directly ! | |||
"debugServerPath":"/opt/toolchains/dc/bin/dc-tool-ip", | |||
"debugServerArgs": "-g -t 192.168.1.210 -x ${workspaceFolder}/${workspaceFolderBasename}.elf", | |||
//"debugServerArgs": "-g -t 192.168.1.210 -x ${workspaceFolder}/2ndmix.elf", | |||
//"stopAtEntry": true, | |||
"externalConsole": false, | |||
"avoidWindowsConsoleRedirection": false, | |||
"internalConsoleOptions": "openOnSessionStart", | |||
}, | |||
{ | |||
"name": "SERIAL", | |||
"type": "cppdbg", | |||
"request": "launch", | |||
"preLaunchTask": "Build", | |||
"cwd": "${workspaceFolder}", | |||
"program": "${workspaceFolder}/${workspaceFolderBasename}.elf", | |||
//"program": "${workspaceFolder}/2ndmix.elf", | |||
"MIMode": "gdb", | |||
"miDebuggerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb", | |||
"miDebuggerServerAddress":"localhost:2159",//common misconception: we connect to the gdb server offered by dc-tool-ser, NOT to the Dreamcast directly ! | |||
"debugServerPath":"/opt/toolchains/dc/bin/dc-tool-ser", | |||
"debugServerArgs": "-g -t /dev/ttyS0 -x ${workspaceFolder}/${workspaceFolderBasename}.elf", | |||
//"debugServerArgs": "-g -t /dev/ttyS0 -x ${workspaceFolder}/2ndmix.elf", | |||
//"stopAtEntry": true, | |||
"externalConsole": false, | |||
"avoidWindowsConsoleRedirection": false, | |||
"internalConsoleOptions": "openOnSessionStart", | |||
}, | |||
{ | |||
"name": "LXDream", | "name": "LXDream", | ||
"type": "cppdbg", | "type": "cppdbg", | ||
"request": "launch", | "request": "launch", | ||
"preLaunchTask": "Build", | "preLaunchTask": "Build", | ||
"cwd": "${workspaceRoot}", | "cwd": "${workspaceRoot}", | ||
/ | "program": "${workspaceFolder}/${workspaceFolderBasename}.elf", | ||
"program": "${ | //"program": "${workspaceFolder}/2ndmix.elf", | ||
"miDebuggerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb", | |||
"miDebuggerPath": " | |||
"setupCommands": [{ | "setupCommands": [{ | ||
"text": "set architecture sh", | "text": "set architecture sh", | ||
Line 128: | Line 222: | ||
"debugServerPath": "PATH_TO_LXDREAM", | "debugServerPath": "PATH_TO_LXDREAM", | ||
// lxdream-nitro flags | // lxdream-nitro flags | ||
"debugServerArgs": "--log=DEBUG --gdb-sh4=9999 -A null -e ${workspaceRoot}/ | "debugServerArgs": "--log=DEBUG --gdb-sh4=9999 -A null -e ${workspaceRoot}/${workspaceFolderBasename}.elf -n", | ||
//"debugServerArgs": "--log=DEBUG --gdb-sh4=9999 -A null -e ${workspaceRoot}/2ndmix.elf -n", | |||
"filterStdout": true, | "filterStdout": true, | ||
"filterStderr": true, | "filterStderr": true, | ||
// run on connect | // run on connect | ||
"stopAtConnect": false, | "stopAtConnect": false, | ||
// stop at main | // stop at main | ||
"stopAtEntry": true, | "stopAtEntry": true, | ||
"externalConsole": false, | |||
"avoidWindowsConsoleRedirection": false, | |||
"internalConsoleOptions": "openOnSessionStart", | |||
"launchCompleteCommand": "exec-run", | "launchCompleteCommand": "exec-run", | ||
"serverStarted": "SH4 GDB server running on port", | "serverStarted": "SH4 GDB server running on port", | ||
"useExtendedRemote": true | "useExtendedRemote": true | ||
} | } | ||
] | ] | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Note that for the 3 launch configurations above, you have 2 lines for | |||
"program" and "debugServerArgs", one of which is commented out. | |||
${workspaceFolderBasename} is the name of your project directory (eg: 2ndmix), and if that matches the name of your target .elf file (eg: 2ndmix.elf), then you can use ${workspaceFolderBasename}. | |||
If not, you can just use the other line by replacing ${workspaceFolderBasename} with the real .elf filename. | |||
You'll also need to replace "PATH_TO_LXDREAM" with the path to the emulator installed on your pc. | |||
==== Launching a Debug session ==== | |||
{| | |||
| [[File:Vscode debugging.png|thumb|alt=Vscode debugging|Vscode debugging]] | |||
|} | |||
* put a line to initialize gdb in your code (1): | |||
<syntaxhighlight lang="c"> | |||
gdb_init(); | |||
</syntaxhighlight> | |||
If using lxdream-nitro, a gdb server is already provided and so gdb_init() should ```not``` be called. | |||
TODO: conditional include | |||
* insert a breakpoint '''AFTER''' this gdb_init(); line (1). You can't put a breakpoint before or on this line ! | |||
* If want to run it on a real Dreamcast, power it on with the dcload disc loaded, and wait for the blue screen | |||
* Click on the "Debugger" icon (2) on the left | |||
* Select the configuration you want to launch (BBA_LAN, SERIAL, or LXDream)(3) | |||
* Click on the green arrow ("Start Debugging" - F5)(4) | |||
==== Tips ==== | |||
* If you want to print out the value of a variable to the console (Terminal) on the pc, add a line like this to your code: | |||
<syntaxhighlight lang="c"> | |||
dbglog(DBG_INFO, "value is: 0x%08X\n", variable); | |||
</syntaxhighlight> | |||
==== Troubleshooting Tips ==== | |||
* If the dc-tool app does not seem to react anymore: | |||
<syntaxhighlight lang="bash"> | |||
sudo netstat -ap | grep :2159 | |||
sudo kill <pid> | |||
</syntaxhighlight> | |||
== Sources == | |||
[https://forums.sonicretro.org/index.php?threads/setting-up-gdb-with-redream-in-linux.38824/ netstat tip source] | |||
[https://dcemulation.org/phpBB/viewtopic.php?t=105596&start=20 Original VSCode topic on dcemulation.org] |
Latest revision as of 07:09, 21 September 2024
This is a guide to setup your Visual Studio Code project with debugging support on both on a real Dreamcast and with an emulator.
Prerequisites
To start with, this tutorial makes the following assumptions:
- You have already installed and set up your KallistiOS development environment]
- if you want to be able to debug, be sure to compile gdb as specified on that page
- You have already downloaded and installed Visual Studio Code (version 1.78.2 was used for this tutorial)
VSCode Setup
- Launch Visual Studio Code
- (optional but recommended) To keep your configuration settings, plugins, ... specific to Dreamcast projects only:
- Create a "Profile" (Menu: File-Preferences-Profiles) called "Dreamcast"
- Install the following extensions: (Menu: View-Extensions)
- Required:
- C/C++ from Microsoft
- Required only if you are using WSL (Windows Subsystem for Linux):
- (Not recommended at this moment:)
- (Makefile Tools from Microsoft: the current version (June 2023) is not really adapted for remote debugging)
Setup per Project
Compilation
Preparation
(all the following steps happen in Visual Studio Code)
- Open the folder containing your project - eg: /opt/toolchains/dc/kos/examples/dreamcast/2ndmix:
- If you are using WSL:
- "F1" - "Connect To WSL"
- Menu: File-Open Folder...
- If you are using WSL:
- (if you are using Profiles) Make sure that the "Dreamcast" profile is selected (Menu: File-Preferences-Profiles)
- If you are using WSL, check that the C/C++ extension is correctly installed for WSL - if you get a warning like "install in WSL: Ubuntu", do so.
- Create a new subfolder ".vscode"
- insert the following files in the ".vscode" subfolder:
- kos_environ.sh
#!/bin/bash
#set the KOS environtment variables
source /opt/toolchains/dc/kos/environ.sh
- kos_make.sh
#!/bin/bash
#set the KOS environtment variables
source /opt/toolchains/dc/kos/environ.sh
make
exit
- settings.json
{
"C_Cpp.default.includePath": [
"${workspaceFolder}/**",
"/opt/toolchains/dc/kos/include/**",
"/opt/toolchains/dc/kos/kernel/arch/dreamcast/include/**",
"/opt/toolchains/dc/kos/addons/include/**",
"/opt/toolchains/dc/kos-ports/include/**",
"/opt/toolchains/dc/kos-ports/*/include/**"
],
"C_Cpp.default.defines": [
"_arch_dreamcast"
],
"C_Cpp.default.compilerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gcc",
"C_Cpp.default.cStandard": "c11",
"C_Cpp.default.cppStandard": "c++17",
"C_Cpp.default.intelliSenseMode": "",
"terminal.integrated.defaultProfile.linux": "kos-bash",
"terminal.integrated.profiles.linux": {
"kos-bash": {
"path": "/usr/bin/bash",
"args": ["--init-file", "${workspaceFolder}/.vscode/kos_environ.sh" ],
"overrideName": true
}
}
}
(TODO: to be tested for Mac/OSX: probably needs the 2 lines terminal.integrated.*.linux replaced with terminal.integrated.*.osx)
- tasks.json
{
"version": "2.0.0",
"tasks": [
{
"label": "Build",
"type": "process",
"command": "bash",
"args": [
"--init-file", "${workspaceFolder}/.vscode/kos_make.sh"
],
"group": {
"kind": "build",
"isDefault": true
},
},
]
}
The result should look like this:
At this point, you should be able to compile applications for the Dreamcast!
Compilation
You can compile via 2 ways:
- via the VSCode Command Palette - "Tasks: Run Build Task", or
- by opening a "kos-bash" terminal (Menu: View-Terminal if not visible yet, then click on the "+" to see the terminals to choose from, and select "kos-bash"), and typing "make"
In both cases, the compilation should generate an executable file, ending with .elf
Note: "kos-bash" is a bash shell with the "source /opt/toolchains/dc/kos/environ.sh" already executed for you. It should be your default shell in VSCode as long as you used the settings.json mentioned above.
Running a program
For this, we will use the "make run" command that you can find in many (all?) Makefiles of the KallistiOs project, to send and run the program on a real dreamcast:
- Typically, one of the following tools is used to run a program for the Dreamcast:
- on a real Dreamcast:
- via an ethernet cable & a Broadband (BBA) or LAN adapter: dcload-ip
- via a coder's cable & the serial port of the Dreamcast: dcload-serial
- on an emulator, like lxdream-nitro
- Make sure that the KOS_LOADER variable in /opt/toolchains/dc/kos/environ.sh is configured correctly:
- for dcload-ip (example if the IP of the Dreamcast is 192.168.1.210):
export KOS_LOADER="dc-tool-ip -t 192.168.1.210 -x"
- for dcload-serial (example if the Dreamcast is on serial port /dev/ttyS0):
export KOS_LOADER="dc-tool-ser -t /dev/ttyS0 -x"
- for the emulator (example with lxdream-nitro):
export KOS_LOADER="/opt/toolchains/dc/lxdream-nitro/builddir/lxdream-nitro -e"
- If want to run it on a real Dreamcast, power it on with the dcload disc loaded, and wait for the blue screen
- Open a "kos-bash" terminal, and type: make run
- The program will be running on your Dreamcast or on the emulator !
- (If you ran the 2ndmix example, you can press the START button on the Dreamcast pad to exit)
- Note: be sure to not have a gdb_init(); line added in your code when you only want to run a program & not debug it.
Debugging
Preparation
- Make sure that you compiled gdb for the Dreamcast, ie /opt/toolchains/dc/sh-elf/bin/sh-elf-gdb should exist (cfr prerequisites)
- Debugging in Visual Studio Code is configured in a .vscode/launch.json file. You can add as many debugging configurations as you want inside that launch.json file, eg 1 for debugging on a dreamcast, 1 for debugging on an emulator, ...
- insert the following files in the ".vscode" subfolder:
- launch.json (example with the IP of the Dreamcast = 192.168.1.210 for the BBA/LAN or /dev/ttyS0 for the serial cable):
{
"version": "0.2.0",
"configurations": [
{
"name": "BBA_LAN",
"type": "cppdbg",
"request": "launch",
"preLaunchTask": "Build",
"cwd": "${workspaceFolder}",
"program": "${workspaceFolder}/${workspaceFolderBasename}.elf",
//"program": "${workspaceFolder}/2ndmix.elf",
"MIMode": "gdb",
"miDebuggerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb",
"miDebuggerServerAddress":"localhost:2159",//common misconception: we connect to the gdb server offered by dc-tool-ip, NOT to the Dreamcast directly !
"debugServerPath":"/opt/toolchains/dc/bin/dc-tool-ip",
"debugServerArgs": "-g -t 192.168.1.210 -x ${workspaceFolder}/${workspaceFolderBasename}.elf",
//"debugServerArgs": "-g -t 192.168.1.210 -x ${workspaceFolder}/2ndmix.elf",
//"stopAtEntry": true,
"externalConsole": false,
"avoidWindowsConsoleRedirection": false,
"internalConsoleOptions": "openOnSessionStart",
},
{
"name": "SERIAL",
"type": "cppdbg",
"request": "launch",
"preLaunchTask": "Build",
"cwd": "${workspaceFolder}",
"program": "${workspaceFolder}/${workspaceFolderBasename}.elf",
//"program": "${workspaceFolder}/2ndmix.elf",
"MIMode": "gdb",
"miDebuggerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb",
"miDebuggerServerAddress":"localhost:2159",//common misconception: we connect to the gdb server offered by dc-tool-ser, NOT to the Dreamcast directly !
"debugServerPath":"/opt/toolchains/dc/bin/dc-tool-ser",
"debugServerArgs": "-g -t /dev/ttyS0 -x ${workspaceFolder}/${workspaceFolderBasename}.elf",
//"debugServerArgs": "-g -t /dev/ttyS0 -x ${workspaceFolder}/2ndmix.elf",
//"stopAtEntry": true,
"externalConsole": false,
"avoidWindowsConsoleRedirection": false,
"internalConsoleOptions": "openOnSessionStart",
},
{
"name": "LXDream",
"type": "cppdbg",
"request": "launch",
"preLaunchTask": "Build",
"cwd": "${workspaceRoot}",
"program": "${workspaceFolder}/${workspaceFolderBasename}.elf",
//"program": "${workspaceFolder}/2ndmix.elf",
"miDebuggerPath": "/opt/toolchains/dc/sh-elf/bin/sh-elf-gdb",
"setupCommands": [{
"text": "set architecture sh",
"description": "Set GDB Arch to SuperH",
"ignoreFailures" : false,
}],
"miDebuggerServerAddress": ":9999",
// path to lxdream-nitro
"debugServerPath": "PATH_TO_LXDREAM",
// lxdream-nitro flags
"debugServerArgs": "--log=DEBUG --gdb-sh4=9999 -A null -e ${workspaceRoot}/${workspaceFolderBasename}.elf -n",
//"debugServerArgs": "--log=DEBUG --gdb-sh4=9999 -A null -e ${workspaceRoot}/2ndmix.elf -n",
"filterStdout": true,
"filterStderr": true,
// run on connect
"stopAtConnect": false,
// stop at main
"stopAtEntry": true,
"externalConsole": false,
"avoidWindowsConsoleRedirection": false,
"internalConsoleOptions": "openOnSessionStart",
"launchCompleteCommand": "exec-run",
"serverStarted": "SH4 GDB server running on port",
"useExtendedRemote": true
}
]
}
Note that for the 3 launch configurations above, you have 2 lines for "program" and "debugServerArgs", one of which is commented out. ${workspaceFolderBasename} is the name of your project directory (eg: 2ndmix), and if that matches the name of your target .elf file (eg: 2ndmix.elf), then you can use ${workspaceFolderBasename}. If not, you can just use the other line by replacing ${workspaceFolderBasename} with the real .elf filename.
You'll also need to replace "PATH_TO_LXDREAM" with the path to the emulator installed on your pc.
Launching a Debug session
- put a line to initialize gdb in your code (1):
gdb_init();
If using lxdream-nitro, a gdb server is already provided and so gdb_init() should ```not``` be called.
TODO: conditional include
- insert a breakpoint AFTER this gdb_init(); line (1). You can't put a breakpoint before or on this line !
- If want to run it on a real Dreamcast, power it on with the dcload disc loaded, and wait for the blue screen
- Click on the "Debugger" icon (2) on the left
- Select the configuration you want to launch (BBA_LAN, SERIAL, or LXDream)(3)
- Click on the green arrow ("Start Debugging" - F5)(4)
Tips
- If you want to print out the value of a variable to the console (Terminal) on the pc, add a line like this to your code:
dbglog(DBG_INFO, "value is: 0x%08X\n", variable);
Troubleshooting Tips
- If the dc-tool app does not seem to react anymore:
sudo netstat -ap | grep :2159
sudo kill <pid>