vscode-cmsis-solution-docs/site/tipsandtricks.html at d128ec833edba8a4e63e6129be0a483b9cc449c8 · KeilChris/vscode-cmsis-solution-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <link rel="shortcut icon" href="img/favicon.ico" />
    <title>Tips and Tricks - Arm Keil Studio for VS Code</title>
    <link rel="stylesheet" href="css/theme.css" />
    <link rel="stylesheet" href="css/theme_extra.css" />
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
        <link href="css/extra.css" rel="stylesheet" />

      <script>
        // Current page data
        var mkdocs_page_name = "Tips and Tricks";
        var mkdocs_page_input_path = "tipsandtricks.md";
        var mkdocs_page_url = null;
      </script>

    <!--[if lt IE 9]>
      <script src="js/html5shiv.min.js"></script>
    <![endif]-->
      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
      <script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
    <div class="wy-side-scroll">
      <div class="wy-side-nav-search">
          <a href="index.html" class="icon icon-home"> Arm Keil Studio for VS Code
        </a><div role="search">
  <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
      <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="index.html">Home</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="userinterface.html">User Interface</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="create_app.html">Create New Solution</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="manage_settings.html">Manage Solution</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="manage_components.html">Software Components</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="debug.html">Debug</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="importuv.html">Import uVision Project</a>
                </li>
              </ul>
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="runexternal.html">Run External Tools</a>
                </li>
              </ul>
              <ul class="current">
                <li class="toctree-l1 current"><a class="reference internal current" href="#">Tips and Tricks</a>
    <ul class="current">
    <li class="toctree-l2"><a class="reference internal" href="#create-vcpkg-configuration-file">Create vcpkg configuration file</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#set-current-solution-in-workspace">Set current solution in workspace</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#documentation-does-not-open">Documentation does not open</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#installing-debug-adapters">Installing debug adapters</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#infineon-kitprog3">Infineon KitProg3</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#microchip-pickit-basic">Microchip PICKit Basic</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#nxp-mcu-link">NXP MCU-Link</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#segger-j-link">SEGGER J-Link</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#stmicroelectronics-st-link">STMicroelectronics ST-Link</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#memory-and-peripheral-inspector-are-missing">Memory and Peripheral Inspector are missing</a>
    </li>
    </ul>
                </li>
              </ul>
      </div>
    </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Arm Keil Studio for VS Code</a>

      </nav>
      <div class="wy-nav-content">
        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html" class="icon icon-home" aria-label="Docs"></a></li>
      <li class="breadcrumb-item active">Tips and Tricks</li>
    <li class="wy-breadcrumbs-aside">
          <a href="https://github.com/MDK-Packs/vscode-cmsis-solution-docs/edit/main/docs/tipsandtricks.md" class="icon icon-github"> Edit on GitHub</a>
    </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div class="section" itemprop="articleBody">

                <h1 id="tips-and-tricks">Tips and tricks</h1>
<p>This chapter contains useful information to help you solve specific issues.</p>
<h2 id="create-vcpkg-configuration-file">Create vcpkg configuration file</h2>
<p>If your solution does not contain the <code>vcpkg-configuration.json</code>, right-click anywhere in the workspace and select
<strong>Configure Arm Tools Environment</strong>. The <strong>Arm Tools Environment Manager</strong> extension then generates this file.</p>
<h2 id="set-current-solution-in-workspace">Set current solution in workspace</h2>
<p>To activate a solution in the <strong>Solution</strong> outline view, use the <strong>Select Active Solution from workspace</strong> option in
<strong>Views and More Actions</strong> <img alt="Views and More Actions icon" src="images/more-actions-icon.png" />.</p>
<h2 id="documentation-does-not-open">Documentation does not open</h2>
<p>If you are using a Linux machine that uses the Snap package manager, your web browser will not be able to open
documentation that is shipped in CMSIS-Packs as the <code>CMSIS_PACK_ROOT</code> directory is in <code>${HOME}/.cache/arm/packs</code> which
is not accessible to Snaps. Likewise, the Keil Studio help is located in <code>${HOME}/.vscode/extensions</code> which is also not
available.</p>
<p>To get this working, use a browser that is not installed as a Snap package:</p>
<ul>
<li>
<p>Uninstall the Snap package. For example, run <code>sudo snap remove firefox</code> in a Terminal.</p>
</li>
<li>
<p>Download the installer from the browser's web site.</p>
</li>
<li>
<p>Install it on your machine.</p>
</li>
</ul>
<h2 id="installing-debug-adapters">Installing debug adapters</h2>
<p>If you are using a third-party debug adapter, make sure that the latest drivers are installed on your machine</p>
<p>Make sure the debug adapters are running the latest firmware and that the <code>PATH</code> variable is set correctly.</p>
<h3 id="infineon-kitprog3">Infineon KitProg3</h3>
<p>Make sure that the latest <a href="https://community.infineon.com/t5/Knowledge-Base-Articles/ModusToolbox-Updating-the-KitProg3-MiniProg4-firmware-from-modus-shell/ta-p/625419#.">firmware is installed</a>.</p>
<h3 id="microchip-pickit-basic">Microchip PICKit Basic</h3>
<p>Use the Python utility <a href="https://pypi.org/project/pycmsisdapswitcher/">pycmsisdapswitcher</a> to switch the firmware to a
CMSIS-DAP v2 implementation.</p>
<h3 id="nxp-mcu-link">NXP MCU-Link</h3>
<p>Make sure that the latest
<a href="https://community.nxp.com/t5/MCUXpresso-General-Knowledge/MCU-Link-installation/ta-p/1180326">firmware is installed</a>.</p>
<h3 id="segger-j-link">SEGGER J-Link</h3>
<p>For J-Link support, visit <a href="https://www.segger.com/downloads/jlink/">J-Link/J-Trace Downloads</a>.</p>
<p>Set the <code>PATH</code> variable to the <code>bin</code> directory of the installation.</p>
<p>Verify the correct operation by entering the command <code>jlink</code> (Windows) or <code>jlinkexe</code> (Linux, macOS) in a Terminal. The
output should similar to this:</p>
<pre><code class="language-sh">SEGGER J-Link Commander V8.24 (Compiled Mar 26 2025 15:34:18)
DLL version V8.24, compiled Mar 26 2025 15:33:37

Connecting to J-Link via USB...FAILED: Cannot connect to J-Link.
J-Link&gt;
</code></pre>
<h3 id="stmicroelectronics-st-link">STMicroelectronics ST-Link</h3>
<p>For ST-LINK/V2 and ST-LINK/V2-1 support on Windows, download the USB driver here:
<a href="https://www.st.com/en/development-tools/stsw-link009.html">STSW-LINK009</a>.</p>
<h2 id="memory-and-peripheral-inspector-are-missing">Memory and Peripheral Inspector are missing</h2>
<p>If your <strong>Debug</strong> view does not contain
<a href="https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.peripheral-inspector">"PERIPHERALS"</a> and you cannot
open the <a href="https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector">Memory Inspector</a>, check if
the extensions are installed correctly. If you had previously uninstalled the
<a href="https://marketplace.visualstudio.com/items?itemName=Arm.arm-debugger">Arm Debugger</a> extension, these two extensions
might have been removed with it. Just reinstall them via the <strong>Extensions</strong> view.</p>

            </div>
          </div><footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
        <a href="runexternal.html" class="btn btn-neutral float-left" title="Run External Tools"><span class="icon icon-circle-arrow-left"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
  </div>

  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" aria-label="Versions">
  <span class="rst-current-version" data-toggle="rst-current-version">

        <span>
          <a href="https://github.com/MDK-Packs/vscode-cmsis-solution-docs" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
        </span>


      <span><a href="runexternal.html" style="color: #fcfcfc">&laquo; Previous</a></span>


  </span>
</div>
    <script src="js/jquery-3.6.0.min.js"></script>
    <script>var base_url = ".";</script>
    <script src="js/theme_extra.js"></script>
    <script src="js/theme.js"></script>
      <script src="search/main.js"></script>
    <script>
        jQuery(function () {
            SphinxRtdTheme.Navigation.enable(true);
        });
    </script>

</body>
</html>