Linux Debugger configuration - Revision history

Fede.tft at 21:44, 10 May 2026

2026-05-10T21:44:46Z

← Older revision		Revision as of 21:44, 10 May 2026
Line 69:		Line 69:
	If you want to upload to the board a new firmware version you can made it through gdb and OpenOCD, you must indicate the binary file and the address of the flash memory of your board:		If you want to upload to the board a new firmware version you can made it through gdb and OpenOCD, you must indicate the binary file and the address of the flash memory of your board:
	<source lang="bash">		<source lang="bash">
			(gdb) monitor reset halt
	(gdb) monitor flash write_image erase main.bin 0x08000000		(gdb) monitor flash write_image erase main.bin 0x08000000
	</source>		</source>
	It'~~s often necessary~~ to ~~perform a reset of the board before and after~~ the ~~firmware upload~~.		Flashing while the board is running of course does not work, so you need to ''reset halt'' first. You'll also want to delete the old breakpoints, as they will not be in random locations.

	[[Category:Installation and Configuration]]		[[Category:Installation and Configuration]]

Fede.tft at 21:42, 10 May 2026

2026-05-10T21:42:54Z

← Older revision		Revision as of 21:42, 10 May 2026
Line 1:		Line 1:
	The debugging of Miosix on Linux can be done through [http://openocd.org/ OpenOCD], that creates a bridge between GDB and the JTAG device.		The debugging of Miosix on Linux can be done through [http://openocd.org/ OpenOCD], that creates a bridge between GDB and the JTAG device.

	== Setting up OpenOCD ==		= Setting up OpenOCD =

	=== Install OpenOCD ===		== Install OpenOCD ==
	<source lang="bash">		<source lang="bash">
	sudo apt~~-get~~ install openocd # Install OpenOCD for Ubuntu/Debian		sudo apt install openocd # Install OpenOCD for Ubuntu/Debian
	</source>		</source>

	=== Run OpenOCD ===		== Run OpenOCD ==
	The OpenOCD configuration is included in the official Miosix distribution under the path 'miosix/arch'~~. You must choose the proper config file for the device in use~~. For example for the stm32f429zi_stm32f4discovery board:		The OpenOCD configuration is included in the official Miosix distribution for most of the supported boards under the path 'miosix/arch/board/<board name>/openocd.cfg'. For example for the stm32f429zi_stm32f4discovery board:
	<source lang="bash">		<source lang="bash">
	openocd -f miosix/arch/~~cortexM4_stm32f4~~/stm32f429zi_stm32f4discovery/~~stm32f4discovery~~.cfg		openocd -f miosix/arch/board/stm32f429zi_stm32f4discovery/openocd.cfg
	</source>		</source>

Line 18:		Line 18:
	'''If breakpoints don't work on your board''' you can try adding the option <code>-c 'gdb_breakpoint_override hard'</code> to the OpenOCD invocation. This option disables GDB software breakpoints and always forces the use of hardware breakpoints, which might be needed if OpenOCD provides an incomplete memory map to GDB.		'''If breakpoints don't work on your board''' you can try adding the option <code>-c 'gdb_breakpoint_override hard'</code> to the OpenOCD invocation. This option disables GDB software breakpoints and always forces the use of hardware breakpoints, which might be needed if OpenOCD provides an incomplete memory map to GDB.

	== Debugging with GDB ==		= Debugging with GDB =
	The GDB used is provided by the official [[Miosix_Toolchain\|Miosix Toolchain]]. If you ~~haven~~'~~t already installed it~~'~~s time to do it~~. ~~The debugger must be launched on the ELF binary~~ file.		The GDB used is provided by the official [[Miosix_Toolchain\|Miosix Toolchain]]. Although the board is flashed with the ''.bin'' file, you'll have to pass the corresponding ''.elf'' file, since this file format includes debugging symbols.
	<source lang="bash">		<source lang="bash">
	arm-miosix-eabi-gdb main.elf		arm-miosix-eabi-gdb main.elf
	</source>		</source>

	=== Connect GDB ===		== Connect GDB ==
	OpenOCD provide a network interface for connect the debugger, the follow command is necessary for establish the connection:		OpenOCD provide a network interface for connect the debugger, the follow command is necessary for establish the connection:
	<source lang="bash">		<source lang="bash">
Line 35:		Line 35:
	</source>		</source>

	=== Reset the board ===		== Reset the board ==
	After the connection (and after each change of configuration) you must reset the board in a safe state:		After the connection (and after each change of configuration) you must reset the board in a safe state:
	<source lang="bash">		<source lang="bash">
Line 41:		Line 41:
	</source>		</source>

	=== Flash a new firmware ===		== Using gdb ==

			This is not a full tutorial on using GDB, information can be found online. Here we only list the basics:

			Setting breakpoints can be done with the ''break'' command followed by the function name or source code line:
			<source lang="bash">
			(gdb) break main
			</source>

			or

			<source lang="bash">
			(gdb) break main.cpp:30
			</source>

			Running the board can be done with the ''run'' command, which will run till the first breakpoint is hit.

			Note that when in-circuit debugging there is only a limited number of hardware breakpoints you can set. If you exceed the number you can remove all breakpoints with:

			<source lang="bash">
			(gdb) del break
			</source>

			and start over.

			== Flash a new firmware ==
	If you want to upload to the board a new firmware version you can made it through gdb and OpenOCD, you must indicate the binary file and the address of the flash memory of your board:		If you want to upload to the board a new firmware version you can made it through gdb and OpenOCD, you must indicate the binary file and the address of the flash memory of your board:
	<source lang="bash">		<source lang="bash">

Daniele.cattaneo: Use extended-remote

2026-04-08T09:22:11Z

Use extended-remote

← Older revision		Revision as of 09:22, 8 April 2026
Line 32:		Line 32:
	The default socket is listening on port 3333 in the loopback interface of your computer. So you can use the default command:		The default socket is listening on port 3333 in the loopback interface of your computer. So you can use the default command:
	<source lang="bash">		<source lang="bash">
	(gdb) target remote :3333		(gdb) target extended-remote :3333
	</source>		</source>

Daniele.cattaneo: Fix openocd link

2026-04-08T09:12:07Z

Fix openocd link

← Older revision		Revision as of 09:12, 8 April 2026
Line 1:		Line 1:
	The debugging of Miosix on Linux can be done through [http://openocd.~~net~~/ OpenOCD], that creates a bridge between GDB and the JTAG device.		The debugging of Miosix on Linux can be done through [http://openocd.org/ OpenOCD], that creates a bridge between GDB and the JTAG device.

	== Setting up OpenOCD ==		== Setting up OpenOCD ==

Daniele.cattaneo: Bold markup rather than italic.

2023-07-03T20:37:35Z

Bold markup rather than italic.

← Older revision		Revision as of 20:37, 3 July 2023
Line 16:		Line 16:
	OpenOCD provides built-in configuration files for many boards, chips and debugging adapters. You can see the entire range of files in the directory <code>/usr/share/openocd/scripts</code>. If Miosix does not provide a configuration file for you, in most cases there will be appropriate scripts available together with OpenOCD.		OpenOCD provides built-in configuration files for many boards, chips and debugging adapters. You can see the entire range of files in the directory <code>/usr/share/openocd/scripts</code>. If Miosix does not provide a configuration file for you, in most cases there will be appropriate scripts available together with OpenOCD.

	''If breakpoints don't work on your board'' you can try adding the option <code>-c 'gdb_breakpoint_override hard'</code> to the OpenOCD invocation. This option disables GDB software breakpoints and always forces the use of hardware breakpoints, which might be needed if OpenOCD provides an incomplete memory map to GDB.		'''If breakpoints don't work on your board''' you can try adding the option <code>-c 'gdb_breakpoint_override hard'</code> to the OpenOCD invocation. This option disables GDB software breakpoints and always forces the use of hardware breakpoints, which might be needed if OpenOCD provides an incomplete memory map to GDB.

	== Debugging with GDB ==		== Debugging with GDB ==

Daniele.cattaneo: Add troubleshooting info for the case in which breakpoints don't work.

2023-07-03T20:37:08Z

Add troubleshooting info for the case in which breakpoints don't work.

← Older revision		Revision as of 20:37, 3 July 2023
Line 15:		Line 15:

	OpenOCD provides built-in configuration files for many boards, chips and debugging adapters. You can see the entire range of files in the directory <code>/usr/share/openocd/scripts</code>. If Miosix does not provide a configuration file for you, in most cases there will be appropriate scripts available together with OpenOCD.		OpenOCD provides built-in configuration files for many boards, chips and debugging adapters. You can see the entire range of files in the directory <code>/usr/share/openocd/scripts</code>. If Miosix does not provide a configuration file for you, in most cases there will be appropriate scripts available together with OpenOCD.

			''If breakpoints don't work on your board'' you can try adding the option <code>-c 'gdb_breakpoint_override hard'</code> to the OpenOCD invocation. This option disables GDB software breakpoints and always forces the use of hardware breakpoints, which might be needed if OpenOCD provides an incomplete memory map to GDB.

	== Debugging with GDB ==		== Debugging with GDB ==

Daniele.cattaneo: Add comment about using cfg scripts included with OpenOCD.

2023-05-29T14:36:41Z

Add comment about using cfg scripts included with OpenOCD.

← Older revision		Revision as of 14:36, 29 May 2023
Line 13:		Line 13:
	openocd -f miosix/arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/stm32f4discovery.cfg		openocd -f miosix/arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/stm32f4discovery.cfg
	</source>		</source>

			OpenOCD provides built-in configuration files for many boards, chips and debugging adapters. You can see the entire range of files in the directory <code>/usr/share/openocd/scripts</code>. If Miosix does not provide a configuration file for you, in most cases there will be appropriate scripts available together with OpenOCD.

	== Debugging with GDB ==		== Debugging with GDB ==

Andreabont at 10:26, 26 June 2016

2016-06-26T10:26:30Z

← Older revision		Revision as of 10:26, 26 June 2016
Line 42:		Line 42:
	(gdb) monitor flash write_image erase main.bin 0x08000000		(gdb) monitor flash write_image erase main.bin 0x08000000
	</source>		</source>
			It's often necessary to perform a reset of the board before and after the firmware upload.

	[[Category:Installation and Configuration]]		[[Category:Installation and Configuration]]

Andreabont: Created page with "The debugging of Miosix on Linux can be done through [http://openocd.net/ OpenOCD], that creates a bridge between GDB and the JTAG device. == Setting up OpenOCD == === Insta..."

2016-06-26T10:16:58Z

Created page with "The debugging of Miosix on Linux can be done through [http://openocd.net/ OpenOCD], that creates a bridge between GDB and the JTAG device. == Setting up OpenOCD == === Insta..."

New page

The debugging of Miosix on Linux can be done through [http://openocd.net/ OpenOCD], that creates a bridge between GDB and the JTAG device.

== Setting up OpenOCD ==

=== Install OpenOCD ===
<source lang="bash">
sudo apt-get install openocd # Install OpenOCD for Ubuntu/Debian
</source>

=== Run OpenOCD ===
The OpenOCD configuration is included in the official Miosix distribution under the path 'miosix/arch'. You must choose the proper config file for the device in use. For example for the stm32f429zi_stm32f4discovery board:
<source lang="bash">
openocd -f miosix/arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/stm32f4discovery.cfg
</source>

== Debugging with GDB ==
The GDB used is provided by the official [[Miosix_Toolchain|Miosix Toolchain]]. If you haven't already installed it's time to do it. The debugger must be launched on the ELF binary file.
<source lang="bash">
arm-miosix-eabi-gdb main.elf
</source>

=== Connect GDB ===
OpenOCD provide a network interface for connect the debugger, the follow command is necessary for establish the connection:
<source lang="bash">
(gdb) target remote <ip>:<port>
</source>

The default socket is listening on port 3333 in the loopback interface of your computer. So you can use the default command:
<source lang="bash">
(gdb) target remote :3333
</source>

=== Reset the board ===
After the connection (and after each change of configuration) you must reset the board in a safe state:
<source lang="bash">
(gdb) monitor reset halt
</source>

=== Flash a new firmware ===
If you want to upload to the board a new firmware version you can made it through gdb and OpenOCD, you must indicate the binary file and the address of the flash memory of your board:
<source lang="bash">
(gdb) monitor flash write_image erase main.bin 0x08000000
</source>

[[Category:Installation and Configuration]]