gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-02-27 01:56:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
d0eb7b5cbc
qmk_firmware/platformdev_rp2040.html

26 lines
110 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Raspberry Pi RP2040 | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
Deploying to gh-pages from @ qmk/qmk_firmware@119e54e9e3db66355a07be5f8db9fcc81b65f1ff 🚀
2024-05-31 00:38:24 +00:00
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
Deploying to gh-pages from @ qmk/qmk_firmware@ef3a939880dc86228eceeb1ed10f158ab0a7bcb2 🚀
2024-09-02 19:47:23 +00:00
<script type="module" src="/assets/app.BUT4IBhn.js"></script>
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<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">
Deploying to gh-pages from @ qmk/qmk_firmware@ef3a939880dc86228eceeb1ed10f158ab0a7bcb2 🚀
2024-09-02 19:47:23 +00:00
<link rel="modulepreload" href="/assets/chunks/theme.BKFyoa45.js">
Deploying to gh-pages from @ qmk/qmk_firmware@78a0adfbb4d2c4e12f93f2a62ded0020d406243e 🚀
2024-06-02 02:43:43 +00:00
<link rel="modulepreload" href="/assets/platformdev_rp2040.md.CYKYMDfc.lean.js">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<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>
Deploying to gh-pages from @ qmk/qmk_firmware@5d76c5280dc0aff398cdce19fa54d0e0725c418d 🚀
2024-08-26 00:06:22 +00:00
<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 4
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RP2040_BOOTLOADER_DOUBLE_TAP_RESET_TIMEOUT</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 200</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">U</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Timeout window in ms in which the double tap can occur.</span></span>
Deploying to gh-pages from @ qmk/qmk_firmware@78a0adfbb4d2c4e12f93f2a62ded0020d406243e 🚀
2024-06-02 02:43:43 +00:00
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RP2040_BOOTLOADER_DOUBLE_TAP_RESET_LED</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> GP17</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Specify a optional status led by GPIO number which blinks when entering the bootloader</span></span></code></pre></div><h2 id="pre-defined-rp2040-boards" tabindex="-1">Pre-defined RP2040 boards <a class="header-anchor" href="#pre-defined-rp2040-boards" aria-label="Permalink to &quot;Pre-defined RP2040 boards&quot;">​</a></h2><p>QMK defines two boards that you can choose from to base your RP2040 powered keyboard upon. These boards provide pre-configured default pins and drivers.</p><h3 id="generic-pro-micro-rp2040" tabindex="-1">Generic Pro Micro RP2040 <a class="header-anchor" href="#generic-pro-micro-rp2040" aria-label="Permalink to &quot;Generic Pro Micro RP2040&quot;">​</a></h3><p>This is the default board that is chosen, unless any other RP2040 board is selected in your keyboards <code>rules.mk</code> file. It assumes a pin layout for the I2C, SPI and Serial drivers which is identical to the Sparkfun Pro Micro RP2040, however all values can be overwritten by defining them in your keyboards <code>config.h</code> file. The <a href="#double-tap">double-tap</a> reset to enter boot-loader behavior is activated by default.</p><table><thead><tr><th>Driver configuration define</th><th>Value</th></tr></thead><tbody><tr><td><strong>I2C driver</strong></td><td></td></tr><tr><td><code>I2C_DRIVER</code></td><td><code>I2CD1</code></td></tr><tr><td><code>I2C1_SDA_PIN</code></td><td><code>GP2</code></td></tr><tr><td><code>I2C1_SCL_PIN</code></td><td><code>GP3</code></td></tr><tr><td><strong>SPI driver</strong></td><td></td></tr><tr><td><code>SPI_DRIVER</code></td><td><code>SPID0</code></td></tr><tr><td><code>SPI_SCK_PIN</code></td><td><code>GP18</code></td></tr><tr><td><code>SPI_MISO_PIN</code></td><td><code>GP20</code></td></tr><tr><td><code>SPI_MOSI_PIN</code></td><td><code>GP19</code></td></tr><tr><td><strong>Serial driver</strong></td><td></td></tr><tr><td><code>SERIAL_USART_DRIVER</code> (<a href="./drivers/serial#the-sio-driver">SIO Driver</a> only)</td><td><code>SIOD0</code></td></tr><tr><td><code>SOFT_SERIAL_PIN</code></td><td>undefined, use <code>SERIAL_USART_TX_PIN</code></td></tr><tr><td><code>SERIAL_USART_TX_PIN</code></td><td><code>GP0</code></td></tr><tr><td><code>SERIAL_USART_RX_PIN</code></td><td><code>GP1</code></td></tr><tr><td><strong>UART driver</strong></td><td></td></tr><tr><td><code>UART_DRIVER</code></td><td><code>SIOD0</code></td></tr><tr><td><code>UART_TX_PIN</code></td><td><code>GP0</code></td></tr><tr><td><code>UART_RX_PIN</code></td><td><code>GP1</code></td></tr></tbody></table><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The pin-outs of Adafruit&#39;s KB2040 and Boardsource&#39;s Blok both deviate from the Sparkfun Pro Micro RP2040. Lookup the pin-out of these boards and adjust your keyboards pin definition accordingly if you want to use these boards.</p></div><h3 id="generic-rp2040-board" tabindex="-1">Generic RP2040 board <a class="header-anchor" href="#generic-rp2040-board" aria-label="Permalink to &quot;Generic RP2040 board&quot;">​</a></h3><p>This board can be chosen as a base for RP2040 keyboards which configure all necessary pins and drivers themselves and do not wish to leverage the configuration matching the Generic Pro Micro RP2040 board. Thus it doesn&#39;t provide any pre-configured pins or drivers. To select this board add the following line to your keyboards <code>rules.mk</code> file.</p><div class="language-make vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">make</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">BOARD = GENERIC_RP_RP2040</span></span></code></pre></div><h2 id="split-keyboard-sup
Deploying to gh-pages from @ qmk/qmk_firmware@ef3a939880dc86228eceeb1ed10f158ab0a7bcb2 🚀
2024-09-02 19:47:23 +00:00
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20220226.md\":\"BWO5r_ec\",\"capabilities.md\":\"DgKwcj5n\",\"changelog_20240825.md\":\"BZM0WSFG\",\"api_overview.md\":\"0FPaUsMb\",\"cli_configuration.md\":\"CGSB128P\",\"breaking_changes_history.md\":\"CJNU0o77\",\"breaking_changes.md\":\"y7zfo29K\",\"cli.md\":\"BLzAdA6l\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"breaking_changes_instructions.md\":\"C99NYDjO\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"drivers_is31fl3733.md\":\"B2SurzgJ\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"config_options.md\":\"DvMeqlpB\",\"configurator_architecture.md\":\"DEFTvTlS\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"configurator_step_by_step.md\":\"CB5U_ksW\",\"custom_matrix.md\":\"DMnRw_5l\",\"drivers_is31fl3742a.md\":\"CKPjB5T1\",\"contributing.md\":\"CgMx5YLW\",\"drivers_flash.md\":\"DhWcHp8S\",\"changelog_20200829.md\":\"CoqrOffn\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20221126.md\":\"DpbrnXeC\",\"drivers_is31fl3736.md\":\"Cr5SQU0k\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"cli_development.md\":\"3xFA2OvS\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"drivers_is31fl3236.md\":\"BsbsN_Nu\",\"drivers_is31fl3729.md\":\"uZAm-59P\",\"drivers_uart.md\":\"BNBs-m3h\",\"drivers_snled27351.md\":\"Cq725B0_\",\"drivers_spi.md\":\"tJVeIT7e\",\"drivers_serial.md\":\"CnlLG_H1\",\"changelog_20210828.md\":\"DNbHIuuM\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"arm_debugging.md\":\"BH-H2Ukz\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"feature_eeprom.md\":\"a0eoTZm7\",\"features_audio.md\":\"DWNYte3W\",\"feature_userspace.md\":\"BsmY9yWw\",\"custom_quantum_functions.md\":\"Br1xUGGa\",\"feature_layouts.md\":\"qcy8hNMO\",\"changelog_20240225.md\":\"B4-WrXj6\",\"changelog_20210529.md\":\"CR1YNfZX\",\"changelog_20220827.md\":\"DjPthqDk\",\"changelog_20211127.md\":\"ClUawWkq\",\"feature_macros.md\":\"By1M5R8G\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"feature_layers.md\":\"8GwBUTZN\",\"api_development_environment.md\":\"EhJClb9f\",\"api_docs.md\":\"CRoD6CbL\",\"drivers_is31fl3743a.md\":\"9TiNS_bm\",\"changelog_20240526.md\":\"DAmAEDG5\",\"capabilities_inc.md\":\"Ca9zpMce\",\"data_driven_config.md\":\"BvLQ7P20\",\"drivers_is31fl3741.md\":\"DzsuNWJt\",\"features_caps_word.md\":\"BDQGM0-x\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"drivers_is31fl3745.md\":\"CpCpR0Np\",\"drivers_gpio.md\":\"C5PvyJVh\",\"drivers_is31fl3746a.md\":\"BFczK5c-\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"drivers_apa102.md\":\"Cl7Xer3S\",\"drivers_i2c.md\":\"Cuj87reB\",\"drivers_aw20216s.md\":\"CgKehEzB\",\"faq_debug.md\":\"DuThValw\",\"cli_commands.md\":\"DGx-qNiE\",\"drivers_audio.md\":\"mqaz6p5N\",\"drivers_is31fl3218.md\":\"C7Rok4l6\",\"faq_build.md\":\"DL_WezA1\",\"drivers_adc.md\":\"DzU8txf8\",\"easy_maker.md\":\"DAfbIK4w\",\"faq_general.md\":\"BOlGsWSk\",\"faq_keymap.md\":\"BsEmEZTo\",\"faq_misc.md\":\"qGrhOTu4\",\"changelog_20201128.md\":\"7XXL02Bn\",\"drivers_eeprom.md\":\"DMr_G_5d\",\"api_development_overview.md\":\"Dcey4ntL\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"features_bluetooth.md\":\"CiAjl875\",\"drivers_is31fl3731.md\":\"_mTT68lh\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"feature_converters.md\":\"DcwmzUcD\",\"changelog_20230827.md\":\"NSPhmB6l\",\"features_led_indicators.md\":\"BI857zKH\",\"features_leader_key.md\":\"DBQTnBRh\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"newbs_testing_debugging.md\":\"D-c7Gle_\",\"one_shot_keys.md\":\"QR09rSb-\",\"other_eclipse.md\":\"C-zqyJO9\",\"features_encoders.md\":\"BY--6WYQ\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_command.md\":\"Byl9YoT7\",\"features_backlight.md\":\"D7R4FkYo\",\"features_autocorrect.md\":\"DHRDcuho\",\"changelog_20230528.md\":\"nX9R48zP\",\"features_hd44780.md\":\"15K40o_e\",\"features_os_detection.md\":\"DZKTWvSd\",\"features_oled
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
</body>
</html>
Reference in New Issue Copy Permalink