You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation, mainly to clarify use of onboard KitProg3 debug
adapter and Infineon custom OpenOCD.
Signed-off-by: Hakan Jansson <[email protected]>
Copy file name to clipboardExpand all lines: boards/infineon/cyw920829m2evk_02/doc/index.rst
+47-23Lines changed: 47 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,8 @@ Hardware
19
19
20
20
For more information about the CYW20829 SoC and CYW920829M2EVK-02 board:
21
21
22
-
- `CYW920829M2EVK-02 Website`_
23
-
- `CYW920829M2EVK-02 BT User Guide`_
24
-
22
+
- `CYW20829 SoC Website`_
23
+
- `CYW920829M2EVK-02 Board Website`_
25
24
26
25
Kit Features:
27
26
=============
@@ -86,51 +85,76 @@ To fetch Binary Blobs:
86
85
Build blinking led sample
87
86
*************************
88
87
89
-
Here is an example for the :zephyr:code-sample:`blinky` application.
88
+
Here is an example for building the :zephyr:code-sample:`blinky` sample application.
90
89
91
90
.. zephyr-app-commands::
92
91
:zephyr-app: samples/basic/blinky
93
92
:board: cyw920829m2evk_02
94
-
:goals: build flash
93
+
:goals: build
95
94
96
-
OpenOCD Installation
97
-
====================
95
+
Programming and Debugging
96
+
*************************
98
97
99
-
To get the OpenOCD package, it is required that you
98
+
The CYW920829M2EVK-02 includes an onboard programmer/debugger (`KitProg3`_) to provide debugging, flash programming, and serial communication over USB. Flash and debug commands use OpenOCD and require a custom Infineon OpenOCD version, that supports KitProg3, to be installed.
100
99
101
-
1. Download and install the `ModusToolbox`_ software.
102
-
2. After the installation, add the directory containing the OpenOCD scripts to your environment's PATH variable.
100
+
Infineon OpenOCD Installation
101
+
=============================
103
102
103
+
Both the full `ModusToolbox`_ and the `ModusToolbox Programming Tools`_ packages include Infineon OpenOCD. Installing either of these packages will also install Infineon OpenOCD. If neither package is installed, a minimal installation can be done by downloading the `Infineon OpenOCD`_ release for your system and manually extract the files to a location of your choice.
104
104
105
-
Programming and Debugging
106
-
*************************
105
+
.. note:: Linux requires device access rights to be set up for KitProg3. This is handled automatically by the ModusToolbox and ModusToolbox Programming Tools installations. When doing a minimal installation, this can be done manually by executing the script ``openocd/udev_rules/install_rules.sh``.
106
+
107
+
West Commands
108
+
=============
107
109
108
-
The CYW920829M2EVK-02 includes an onboard programmer/debugger (KitProg3) to provide debugging, flash programming, and serial communication over USB. Flash and debug commands must be pointed to the Cypress OpenOCD you downloaded above.
110
+
The path to the installed Infineon OpenOCD executable must be available to the ``west`` tool commands. There are multiple ways of doing this. The example below uses a permanent CMake argument to set the CMake variable ``OPENOCD``.
109
111
110
-
On Windows:
112
+
.. tabs::
113
+
.. group-tab:: Windows
111
114
112
-
.. code-block:: shell
115
+
.. code-block:: shell
113
116
114
-
west flash --openocd path/to/infineon/openocd/bin/openocd.exe
115
-
west debug --openocd path/to/infineon/openocd/bin/openocd.exe
117
+
# Run west config once to set permanent CMake argument
118
+
west config build.cmake-args -- -DOPENOCD=path/to/infineon/openocd/bin/openocd.exe
116
119
117
-
On Linux:
120
+
# Do a pristine build once after setting CMake argument
121
+
west build -b cyw920829m2evk_02 -p always samples/basic/blinky
118
122
119
-
.. code-block:: shell
123
+
west flash
124
+
west debug
120
125
121
-
west flash --openocd path/to/infineon/openocd/bin/openocd
122
-
west debug --openocd path/to/infineon/openocd/bin/openocd
126
+
.. group-tab:: Linux
127
+
128
+
.. code-block:: shell
129
+
130
+
# Run west config once to set permanent CMake argument
131
+
west config build.cmake-args -- -DOPENOCD=path/to/infineon/openocd/bin/openocd
132
+
133
+
# Do a pristine build once after setting CMake argument
134
+
west build -b cyw920829m2evk_02 -p always samples/basic/blinky
135
+
136
+
west flash
137
+
west debug
123
138
124
139
Once the gdb console starts after executing the west debug command, you may now set breakpoints and perform other standard GDB debugging on the CYW20829 CM33 core.
0 commit comments