Skip to content

Commit f371ea4

Browse files
hakanjanssonnashif
authored andcommitted
boards: infineon: cyw920829m2evk_02: update documentation
Update documentation, mainly to clarify use of onboard KitProg3 debug adapter and Infineon custom OpenOCD. Signed-off-by: Hakan Jansson <[email protected]>
1 parent ce157c6 commit f371ea4

File tree

2 files changed

+47
-23
lines changed

2 files changed

+47
-23
lines changed
Binary file not shown.

boards/infineon/cyw920829m2evk_02/doc/index.rst

Lines changed: 47 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@ Hardware
1919

2020
For more information about the CYW20829 SoC and CYW920829M2EVK-02 board:
2121

22-
- `CYW920829M2EVK-02 Website`_
23-
- `CYW920829M2EVK-02 BT User Guide`_
24-
22+
- `CYW20829 SoC Website`_
23+
- `CYW920829M2EVK-02 Board Website`_
2524

2625
Kit Features:
2726
=============
@@ -86,51 +85,76 @@ To fetch Binary Blobs:
8685
Build blinking led sample
8786
*************************
8887

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.
9089

9190
.. zephyr-app-commands::
9291
:zephyr-app: samples/basic/blinky
9392
:board: cyw920829m2evk_02
94-
:goals: build flash
93+
:goals: build
9594

96-
OpenOCD Installation
97-
====================
95+
Programming and Debugging
96+
*************************
9897

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.
10099

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+
=============================
103102

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.
104104

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+
=============
107109

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``.
109111

110-
On Windows:
112+
.. tabs::
113+
.. group-tab:: Windows
111114

112-
.. code-block:: shell
115+
.. code-block:: shell
113116
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
116119
117-
On Linux:
120+
# Do a pristine build once after setting CMake argument
121+
west build -b cyw920829m2evk_02 -p always samples/basic/blinky
118122
119-
.. code-block:: shell
123+
west flash
124+
west debug
120125
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
123138
124139
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.
125140

126-
.. _CYW920829M2EVK-02 Website:
141+
.. _CYW20829 SoC Website:
127142
https://www.infineon.com/cms/en/product/wireless-connectivity/airoc-bluetooth-le-bluetooth-multiprotocol/airoc-bluetooth-le/cyw20829/
128143

144+
.. _CYW920829M2EVK-02 Board Website:
145+
https://www.infineon.com/cms/en/product/evaluation-boards/cyw920829m2evk-02/
146+
129147
.. _CYW920829M2EVK-02 BT User Guide:
130148
https://www.infineon.com/cms/en/product/wireless-connectivity/airoc-bluetooth-le-bluetooth-multiprotocol/airoc-bluetooth-le/cyw20829/#!?fileId=8ac78c8c8929aa4d018a16f726c46b26
131149

132150
.. _ModusToolbox:
133151
https://softwaretools.infineon.com/tools/com.ifx.tb.tool.modustoolbox
134152

153+
.. _ModusToolbox Programming Tools:
154+
https://softwaretools.infineon.com/tools/com.ifx.tb.tool.modustoolboxprogtools
155+
135156
.. _Infineon OpenOCD:
136-
https://github.com/infineon/openocd/releases/tag/release-v4.3.0
157+
https://github.com/Infineon/openocd/releases/latest
158+
159+
.. _KitProg3:
160+
https://github.com/Infineon/KitProg3

0 commit comments

Comments
 (0)