qmk_firmware/assets/arm_debugging.md.BiRXU6nl.js

import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.B9AX-CPi.js";
const __pageData = JSON.parse('{"title":"ARM Debugging using Eclipse","description":"","frontmatter":{},"headers":[],"relativePath":"arm_debugging.md","filePath":"arm_debugging.md"}');
const _sfc_main = { name: "arm_debugging.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="arm-debugging-using-eclipse" tabindex="-1">ARM Debugging using Eclipse <a class="header-anchor" href="#arm-debugging-using-eclipse" aria-label="Permalink to &quot;ARM Debugging using Eclipse&quot;">​</a></h1><p>This page describes how to setup debugging for ARM MCUs using an SWD adapter and open-source/free tools. In this guide we will install GNU MCU Eclipse IDE for C/C++ Developers and OpenOCD together with all the necessary dependencies.</p><p>This guide is catered towards advance users and assumes you can compile an ARM compatible keyboard on your machine using the MAKE flow.</p><h2 id="installing-the-software" tabindex="-1">Installing the software <a class="header-anchor" href="#installing-the-software" aria-label="Permalink to &quot;Installing the software&quot;">​</a></h2><p>The main objective here is to get the MCU Eclipse IDE correctly installed on our machine. The necessary instructions are derived from <a href="https://gnu-mcu-eclipse.github.io/install/" target="_blank" rel="noreferrer">this</a> install guide.</p><h3 id="the-xpack-manager" tabindex="-1">The xPack Manager <a class="header-anchor" href="#the-xpack-manager" aria-label="Permalink to &quot;The xPack Manager&quot;">​</a></h3><p>This tool is a software package manager and it is used to help us get the necessary dependencies.</p><p>XPM runs using Node.js so grab that from <a href="https://nodejs.org/en/" target="_blank" rel="noreferrer">here</a>. After installation, open a terminal and type <code>npm -v</code>. A reply with the version number means that the installation was successful.</p><p>XPM installation instructions can be found <a href="https://www.npmjs.com/package/xpm" target="_blank" rel="noreferrer">here</a> and are OS specific. Entering <code>xpm --version</code> to your terminal should return the software version.</p><h3 id="the-arm-toolchain" tabindex="-1">The ARM Toolchain <a class="header-anchor" href="#the-arm-toolchain" aria-label="Permalink to &quot;The ARM Toolchain&quot;">​</a></h3><p>Using XPM it is very easy to install the ARM toolchain. Enter the command <code>xpm install --global @xpack-dev-tools/arm-none-eabi-gcc</code>.</p><h3 id="windows-build-tools" tabindex="-1">Windows build tools <a class="header-anchor" href="#windows-build-tools" aria-label="Permalink to &quot;Windows build tools&quot;">​</a></h3><p>If you are using windows you need to install this!</p><p><code>xpm install --global @gnu-mcu-eclipse/windows-build-tools</code></p><h3 id="programmer-debugger-drivers" tabindex="-1">Programmer/Debugger Drivers <a class="header-anchor" href="#programmer-debugger-drivers" aria-label="Permalink to &quot;Programmer/Debugger Drivers&quot;">​</a></h3><p>Now it&#39;s time to install your programmer&#39;s drivers. This tutorial was made using an ST-Link v2 which you can get from almost anywhere. If you have an ST-Link the drivers can be found <a href="https://www.st.com/en/development-tools/stsw-link009.html" target="_blank" rel="noreferrer">here</a> otherwise consult the manufacturer of your tool.</p><h3 id="openocd" tabindex="-1">OpenOCD <a class="header-anchor" href="#openocd" aria-label="Permalink to &quot;OpenOCD&quot;">​</a></h3><p>This dependency allows SWD access from GDB and it is essential for debugging. Run <code>xpm install --global @xpack-dev-tools/openocd</code>.</p><h3 id="java" tabindex="-1">Java <a class="header-anchor" href="#java" aria-label="Permalink to &quot;Java&quot;">​</a></h3><p>Java is needed by Eclipse so please download it from <a href="https://www.oracle.com/technetwork/java/javase/downloads/index.html" target="_blank" rel="noreferrer">here</a>.</p><h3 id="gnu-mcu-eclipse-ide" tabindex="-1">GNU MCU Eclipse IDE <a class="header-anchor" href="#gnu-mcu-eclipse-ide" aria-label="Permalink to &quot;GNU MCU Eclipse IDE&quot;">​</a></h3><p>Now its finally time to install the IDE. Use the Release page <a href="https://github.com/gnu-mcu-eclipse/org.eclipse.epp.packages/releases/" target="_blank" rel="noreferrer">here</a> to get the
const _hoisted_44 = [
  _hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  return openBlock(), createElementBlock("div", null, _hoisted_44);
}
const arm_debugging = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
  __pageData,
  arm_debugging as default
};