qmk_firmware/platformdev_selecting_arm_mcu.html

25 lines
103 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Choosing an Arm MCU | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
<script type="module" src="/assets/app.CQwyyYY2.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.DyMmIvSC.js">
<link rel="modulepreload" href="/assets/chunks/theme.3rW0xt93.js">
<link rel="modulepreload" href="/assets/platformdev_selecting_arm_mcu.md.aF4DUsvb.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="./" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> STM32_HAS_OTG2</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> TRUE</span></span></code></pre></div><p>For the most part, this is the bare minimum to be able to have a high confidence that QMK will be able to run on your MCU. After that, it&#39;s all up to configuration.</p><h3 id="non-stm32-families" tabindex="-1">Non-STM32 families <a class="header-anchor" href="#non-stm32-families" aria-label="Permalink to &quot;Non-STM32 families&quot;"></a></h3><p>ChibiOS does have support for a handful of non-STM32 devices, and the list can be found in QMK&#39;s <a href="https://github.com/qmk/ChibiOS/tree/master/os/hal/ports" target="_blank" rel="noreferrer">ChibiOS fork</a> and <a href="https://github.com/qmk/ChibiOS-Contrib/tree/master/os/hal/ports" target="_blank" rel="noreferrer">ChibiOS-Contrib fork</a>. Non-STM32 support is likely out of date, and only supports ancient MCUs -- whilst it might be possible to use these, it&#39;s not recommended.</p><p>Do note that there are sometimes licensing restrictions with respect to redistribution. As an example, binaries built for nRF5 are not able to be redistributed via QMK Configurator, due to the licensing of their board support package.</p><h2 id="add-new-stm32-mcu" tabindex="-1">Adding support for a new STM32 MCU (for an existing family) <a class="header-anchor" href="#add-new-stm32-mcu" aria-label="Permalink to &quot;Adding support for a new STM32 MCU (for an existing family) {#add-new-stm32-mcu}&quot;"></a></h2><p>Usually, one can &quot;masquerade&quot; as an existing MCU of the same family, especially if the only difference is RAM or Flash size. As an example, some MCUs within the same family are virtually identical, with the exception of adding a cryptographic peripheral -- STM32L072 vs. STM32L082 for instance. Given the unlikely use of the cryptographic peripheral, L082 chips can actually run as if they&#39;re an L072, and can be targeted accordingly.</p><p>Adding proper support for new MCUs within an existing STM32 family should ideally be upstreamed to ChibiOS. In general, this will require modifications of the <code>stm32_registry.h</code> file, providing correct responses for the same <code>#define</code>s provided for the other MCUs in that family.</p><h2 id="add-new-stm32-family" tabindex="-1">Adding support for a new STM32 Family <a class="header-anchor" href="#add-new-stm32-family" aria-label="Permalink to &quot;Adding support for a new STM32 Family {#add-new-stm32-family}&quot;"></a></h2><p>If this is a requirement, this needs to go through upstream ChibiOS before QMK would consider accepting boards targeting the new family. More information for porting should be sought by approaching ChibiOS directly, rather than through QMK.</p><h2 id="add-new-mcu-family" tabindex="-1">Adding support for a new MCU Family <a class="header-anchor" href="#add-new-mcu-family" aria-label="Permalink to &quot;Adding support for a new MCU Family {#add-new-mcu-family}&quot;"></a></h2><p>As stated earlier, in order for a new MCU family to be supported by QMK, it needs to be upstreamed into ChibiOS-Contrib before QMK will consider accepting boards using it. The same principle applies for development -- you&#39;re best approaching the ChibiOS-Contrib maintainers to get a bit more of an idea on what&#39;s involved with upstreaming your contribution.</p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link prev" href="/api_development_overview" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Previous page</span><span class="title" data-v-09de1c0f>Architecture Overview</span><!--]--></a></div><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link next" href="/platformdev_chibios_earlyinit" data-v-09de1c0f><!--[--><span clas
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20210529.md\":\"CR1YNfZX\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"how_a_matrix_works.md\":\"JINKbCuX\",\"changelog_20211127.md\":\"ClUawWkq\",\"features_tri_layer.md\":\"DllHq_Q1\",\"changelog_20230827.md\":\"NSPhmB6l\",\"platformdev_blackpill_f4x1.md\":\"DvObLRuk\",\"configurator_architecture.md\":\"DEFTvTlS\",\"other_eclipse.md\":\"C-zqyJO9\",\"other_vscode.md\":\"Di3vOySR\",\"features_split_keyboard.md\":\"mMTUzI5n\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"platformdev_rp2040.md\":\"CYKYMDfc\",\"flashing_bootloadhid.md\":\"aXGP0bN5\",\"features_stenography.md\":\"Bb_IhUGl\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"porting_your_keyboard_to_qmk.md\":\"CGlGdFj4\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"reference_glossary.md\":\"CXMuxToT\",\"features_key_overrides.md\":\"rVTP6kn9\",\"features_swap_hands.md\":\"DgXe20Mm\",\"features_st7565.md\":\"MoajNurJ\",\"keycodes_magic.md\":\"CGO3hgMm\",\"features_mouse_keys.md\":\"C3P3pYuE\",\"getting_started_introduction.md\":\"BOJreqSs\",\"newbs_getting_started.md\":\"DD4a5qPC\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"api_development_overview.md\":\"Dcey4ntL\",\"api_development_environment.md\":\"EhJClb9f\",\"capabilities_inc.md\":\"Ca9zpMce\",\"api_overview.md\":\"0FPaUsMb\",\"features_tap_dance.md\":\"CKLVpnIn\",\"arm_debugging.md\":\"BH-H2Ukz\",\"reference_configurator_support.md\":\"FaBQzIj6\",\"ref_functions.md\":\"BVI2uXSN\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"breaking_changes.md\":\"BtdqWQlY\",\"cli.md\":\"BLzAdA6l\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"cli_configuration.md\":\"CGSB128P\",\"cli_development.md\":\"3xFA2OvS\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20220827.md\":\"DjPthqDk\",\"hardware_drivers.md\":\"BUnx48D9\",\"hardware_keyboard_guidelines.md\":\"CJevsanE\",\"changelog_20220226.md\":\"BWO5r_ec\",\"changelog_20210828.md\":\"DNbHIuuM\",\"changelog_20200829.md\":\"CoqrOffn\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"keycodes_basic.md\":\"CHIeCvwn\",\"keycodes_us_ansi_shifted.md\":\"Cs78SDfM\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"config_options.md\":\"DvMeqlpB\",\"data_driven_config.md\":\"BvLQ7P20\",\"contributing.md\":\"DLsp4vSA\",\"custom_matrix.md\":\"DMnRw_5l\",\"documentation_templates.md\":\"Bhkum0wD\",\"quantum_painter.md\":\"BK_I9g4h\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"custom_quantum_functions.md\":\"DrUNiV1i\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_adc.md\":\"DzU8txf8\",\"drivers_eeprom.md\":\"B_6soqar\",\"drivers_gpio.md\":\"C5PvyJVh\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"drivers_audio.md\":\"mqaz6p5N\",\"drivers_spi.md\":\"tJVeIT7e\",\"drivers_i2c.md\":\"Cuj87reB\",\"drivers_flash.md\":\"DhWcHp8S\",\"faq_keymap.md\":\"BsEmEZTo\",\"drivers_serial.md\":\"qxjytVdM\",\"faq_general.md\":\"BC3pFw4U\",\"feature_eeprom.md\":\"a0eoTZm7\",\"feature_layers.md\":\"8GwBUTZN\",\"feature_userspace.md\":\"BsmY9yWw\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"feature_layouts.md\":\"qcy8hNMO\",\"feature_macros.md\":\"By1M5R8G\",\"features_audio.md\":\"DWNYte3W\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"features_auto_shift.md\":\"B9HLt3QM\",\"features_autocorrect.md\":\"DHRDcuho\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"features_caps_word.md\":\"BDQGM0-x\",\"features_backlight.md\":\"D7R4FkYo\",\"features_digitizer.md\":\"DGIGZFVx\",\"features_grave_esc.md\":\"mUNEjUYS\",\"features_encoders.md\":\"B2SX3hG2\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_hd44780.md\":\"15K40o_e\",\"features_joystick.md\":\"CW0gZHec\",\"getting_started_make_guide.md\":\"BjUuEnSh\",\"features_led_indicators.md\":\"CCZhjHe9\",\"features_ke
</body>
</html>