Doc: Update Bare Metal docs
- Describe "Peripheral description file" option - Update screenshots Task-number: QTCREATORBUG-29392 Change-Id: I2d2881a13447dd2f14ac13f3b61cb3306b0e7f30 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Before Width: | Height: | Size: 16 KiB |
BIN
doc/qtcreator/images/qtcreator-baremetal-eblink.webp
Normal file
After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 17 KiB |
BIN
doc/qtcreator/images/qtcreator-baremetal-jlink.webp
Normal file
After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 15 KiB |
BIN
doc/qtcreator/images/qtcreator-baremetal-openocd.webp
Normal file
After Width: | Height: | Size: 9.2 KiB |
Before Width: | Height: | Size: 14 KiB |
BIN
doc/qtcreator/images/qtcreator-baremetal-stlink.webp
Normal file
After Width: | Height: | Size: 9.1 KiB |
@@ -59,8 +59,9 @@
|
|||||||
\section1 Specifying Settings for Debug Server Providers
|
\section1 Specifying Settings for Debug Server Providers
|
||||||
|
|
||||||
To create connections to bare metal devices using a debug server provider,
|
To create connections to bare metal devices using a debug server provider,
|
||||||
select \preferences > \uicontrol Devices
|
select \preferences > \uicontrol Devices > \uicontrol {Bare Metal} >
|
||||||
> \uicontrol {Bare Metal} > \uicontrol Add > \uicontrol Default.
|
\uicontrol Add.
|
||||||
|
|
||||||
The available settings depend on the debug server provider.
|
The available settings depend on the debug server provider.
|
||||||
|
|
||||||
\section2 EBlink
|
\section2 EBlink
|
||||||
@@ -68,7 +69,7 @@
|
|||||||
\l{https://github.com/EmBitz/EBlink}{EBlink} is an ARM Cortex-M debug tool
|
\l{https://github.com/EmBitz/EBlink}{EBlink} is an ARM Cortex-M debug tool
|
||||||
that supports squirrel scripting, live variables, and hot-plugging.
|
that supports squirrel scripting, live variables, and hot-plugging.
|
||||||
|
|
||||||
\image qtcreator-baremetal-eblink.png "Bare metal device preferences for EBlink"
|
\image qtcreator-baremetal-eblink.webp {Bare metal device preferences for EBlink}
|
||||||
|
|
||||||
To specify settings for \EBlink:
|
To specify settings for \EBlink:
|
||||||
|
|
||||||
@@ -105,7 +106,7 @@
|
|||||||
\l{https://www.segger.com/products/debug-probes/j-link/}{J-Link} is a line
|
\l{https://www.segger.com/products/debug-probes/j-link/}{J-Link} is a line
|
||||||
of debug probes by Segger.
|
of debug probes by Segger.
|
||||||
|
|
||||||
\image qtcreator-baremetal-jlink.png "Bare metal device preferences for J-Link"
|
\image qtcreator-baremetal-jlink.webp "Bare metal device preferences for J-Link"
|
||||||
|
|
||||||
To specify settings for J-Link debug probes:
|
To specify settings for J-Link debug probes:
|
||||||
|
|
||||||
@@ -137,7 +138,7 @@
|
|||||||
(JTAG) facility. It enables source level debugging with the GDB compiled
|
(JTAG) facility. It enables source level debugging with the GDB compiled
|
||||||
for the ARM architecture.
|
for the ARM architecture.
|
||||||
|
|
||||||
\image qtcreator-baremetal-openocd.png "Bare metal device preferences for OpenOCD"
|
\image qtcreator-baremetal-openocd.webp "Bare metal device preferences for OpenOCD"
|
||||||
|
|
||||||
To specify settings for \OpenOCD:
|
To specify settings for \OpenOCD:
|
||||||
|
|
||||||
@@ -163,7 +164,7 @@
|
|||||||
\l{https://www.st.com/en/development-tools/stm32-programmers.html#products}
|
\l{https://www.st.com/en/development-tools/stm32-programmers.html#products}
|
||||||
{ST-LINK Utility} is used for programming STM32 microcontrollers.
|
{ST-LINK Utility} is used for programming STM32 microcontrollers.
|
||||||
|
|
||||||
\image qtcreator-baremetal-stlink.png "Bare metal device preferences for St-Link"
|
\image qtcreator-baremetal-stlink.webp "Bare metal device preferences for St-Link"
|
||||||
|
|
||||||
To specify settings for St-Link:
|
To specify settings for St-Link:
|
||||||
|
|
||||||
@@ -202,7 +203,7 @@
|
|||||||
|
|
||||||
\image qtcreator-baremetal-uvision-simulator.png "Bare metal device preferences for uVision Simulator"
|
\image qtcreator-baremetal-uvision-simulator.png "Bare metal device preferences for uVision Simulator"
|
||||||
|
|
||||||
To specify settings for uVision Simulator or uVision St-Link Debugger:
|
To specify settings for uVision Simulator:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
|
|
||||||
@@ -215,11 +216,11 @@
|
|||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
\section3 uVision St-Link Debugger
|
\section3 uVision St-Link or JLink Debugger
|
||||||
|
|
||||||
\image qtcreator-baremetal-uvision-st-link.png "Bare metal device preferences for uVision St-Link"
|
\image qtcreator-baremetal-uvision-st-link.png "Bare metal device preferences for uVision St-Link"
|
||||||
|
|
||||||
To specify settings for uVision St-Link Debugger:
|
To specify settings for uVision St-Link or JLink Debugger:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
|
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
// Copyright (C) 2020 The Qt Company Ltd.
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
//! [baremetal-common]
|
//! [baremetal-common]
|
||||||
@@ -6,6 +6,8 @@
|
|||||||
\li In the \uicontrol Name field, enter a name for the connection.
|
\li In the \uicontrol Name field, enter a name for the connection.
|
||||||
\li In the \uicontrol {Startup mode} field, select the mode to start
|
\li In the \uicontrol {Startup mode} field, select the mode to start
|
||||||
the debug server provider in.
|
the debug server provider in.
|
||||||
|
\li In the \uicontrol {Peripheral description file} field, specify a path to
|
||||||
|
a file that describes the peripherals on the device.
|
||||||
\li In the \uicontrol Host field, select the host name and port number
|
\li In the \uicontrol Host field, select the host name and port number
|
||||||
to connect to the debug server provider.
|
to connect to the debug server provider.
|
||||||
\li In the \uicontrol {Executable file} field, enter the path to the
|
\li In the \uicontrol {Executable file} field, enter the path to the
|
||||||
|