qmk_firmware/drivers/uart.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>UART Driver | 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.CpKBm0Za.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.BIoEq7pR.js">
<link rel="modulepreload" href="/assets/drivers_uart.md.BNBs-m3h.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_SERIAL_USE_USART2</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> TRUE</span></span></code></pre></div><p>Configuration-wise, you&#39;ll need to set up the peripheral as per your MCU&#39;s datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.</p><table><thead><tr><th><code>config.h</code> override</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><code>#define UART_DRIVER</code></td><td>USART peripheral to use - USART1 -&gt; <code>SD1</code>, USART2 -&gt; <code>SD2</code> etc.</td><td><code>SD1</code></td></tr><tr><td><code>#define UART_TX_PIN</code></td><td>The pin to use for TX</td><td><code>A9</code></td></tr><tr><td><code>#define UART_TX_PAL_MODE</code></td><td>The alternate function mode for TX</td><td><code>7</code></td></tr><tr><td><code>#define UART_RX_PIN</code></td><td>The pin to use for RX</td><td><code>A10</code></td></tr><tr><td><code>#define UART_RX_PAL_MODE</code></td><td>The alternate function mode for RX</td><td><code>7</code></td></tr><tr><td><code>#define UART_CTS_PIN</code></td><td>The pin to use for CTS</td><td><code>A11</code></td></tr><tr><td><code>#define UART_CTS_PAL_MODE</code></td><td>The alternate function mode for CTS</td><td><code>7</code></td></tr><tr><td><code>#define UART_RTS_PIN</code></td><td>The pin to use for RTS</td><td><code>A12</code></td></tr><tr><td><code>#define UART_RTS_PAL_MODE</code></td><td>The alternate function mode for RTS</td><td><code>7</code></td></tr></tbody></table><h2 id="api" tabindex="-1">API <a class="header-anchor" href="#api" aria-label="Permalink to &quot;API {#api}&quot;"></a></h2><h3 id="api-uart-init" tabindex="-1"><code>void uart_init(uint32_t baud)</code> <a class="header-anchor" href="#api-uart-init" aria-label="Permalink to &quot;`void uart_init(uint32_t baud)` {#api-uart-init}&quot;"></a></h3><p>Initialize the UART driver. This function must be called only once, before any of the below functions can be called.</p><h4 id="api-uart-init-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-uart-init-arguments" aria-label="Permalink to &quot;Arguments {#api-uart-init-arguments}&quot;"></a></h4><ul><li><code>uint32_t baud</code><br> The baud rate to transmit and receive at. This may depend on the device you are communicating with. Common values are 1200, 2400, 4800, 9600, 19200, 38400, 57600, and 115200.</li></ul><hr><h3 id="api-uart-write" tabindex="-1"><code>void uart_write(uint8_t data)</code> <a class="header-anchor" href="#api-uart-write" aria-label="Permalink to &quot;`void uart_write(uint8_t data)` {#api-uart-write}&quot;"></a></h3><p>Transmit a single byte.</p><h4 id="api-uart-write-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-uart-write-arguments" aria-label="Permalink to &quot;Arguments {#api-uart-write-arguments}&quot;"></a></h4><ul><li><code>uint8_t data</code><br> The byte to write.</li></ul><hr><h3 id="api-uart-read" tabindex="-1"><code>uint8_t uart_read(void)</code> <a class="header-anchor" href="#api-uart-read" aria-label="Permalink to &quot;`uint8_t uart_read(void)` {#api-uart-read}&quot;"></a></h3><p>Receive a single byte.</p><h4 id="api-uart-read-return" tabindex="-1">Return Value <a class="header-anchor" href="#api-uart-read-return" aria-label="Permalink to &quot;Return Value {#api-uart-read-return}&quot;"></a></h4><p>The byte read from the receive buffer. This function will block if the buffer is empty (ie. no data to read).</p><hr><h3 id="api-uart-transmit" tabindex="-1"><code>void uart_transmit(const uint8_t *data, uint16_t length)</code> <a class="header-anchor" href="#api-uart-transmit" aria-label="Permalink to &quot;`void uart_transmit(const uint8_t *data, uint16_t length)` {#api-uart-transmit}&quot;"></a></h3><p>Transmit multiple bytes.</p><h4 id="api-uart-transmit-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-uart-transmit-ar
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20200229.md\":\"DNsowwM1\",\"easy_maker.md\":\"DAfbIK4w\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20201128.md\":\"7XXL02Bn\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"data_driven_config.md\":\"BvLQ7P20\",\"changelog_20210529.md\":\"CR1YNfZX\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"configurator_step_by_step.md\":\"CB5U_ksW\",\"documentation_templates.md\":\"Bhkum0wD\",\"faq_build.md\":\"DL_WezA1\",\"drivers_spi.md\":\"tJVeIT7e\",\"changelog_20221126.md\":\"DpbrnXeC\",\"faq_debug.md\":\"DuThValw\",\"drivers_adc.md\":\"DzU8txf8\",\"capabilities.md\":\"DgKwcj5n\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"changelog_20240526.md\":\"DAmAEDG5\",\"changelog_20240225.md\":\"B4-WrXj6\",\"arm_debugging.md\":\"BH-H2Ukz\",\"breaking_changes.md\":\"BtdqWQlY\",\"capabilities_inc.md\":\"Ca9zpMce\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"cli_configuration.md\":\"CGSB128P\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"cli.md\":\"BLzAdA6l\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"features_backlight.md\":\"D7R4FkYo\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"configurator_architecture.md\":\"DEFTvTlS\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"config_options.md\":\"DvMeqlpB\",\"cli_commands.md\":\"DGx-qNiE\",\"cli_development.md\":\"3xFA2OvS\",\"faq_misc.md\":\"qGrhOTu4\",\"api_overview.md\":\"0FPaUsMb\",\"faq_keymap.md\":\"BsEmEZTo\",\"feature_layouts.md\":\"qcy8hNMO\",\"changelog_20211127.md\":\"ClUawWkq\",\"faq_general.md\":\"BC3pFw4U\",\"contributing.md\":\"KzcJdv8r\",\"drivers_i2c.md\":\"Cuj87reB\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_serial.md\":\"qxjytVdM\",\"drivers_eeprom.md\":\"B_6soqar\",\"changelog_20210227.md\":\"BWOtCaeS\",\"custom_matrix.md\":\"DMnRw_5l\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"features_auto_shift.md\":\"B9HLt3QM\",\"api_development_overview.md\":\"Dcey4ntL\",\"drivers_uart.md\":\"BNBs-m3h\",\"changelog_20220226.md\":\"BWO5r_ec\",\"changelog_20200829.md\":\"CoqrOffn\",\"features_bluetooth.md\":\"CiAjl875\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"drivers_gpio.md\":\"C5PvyJVh\",\"drivers_audio.md\":\"mqaz6p5N\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"feature_eeprom.md\":\"a0eoTZm7\",\"drivers_flash.md\":\"DhWcHp8S\",\"features_digitizer.md\":\"DGIGZFVx\",\"features_caps_word.md\":\"BDQGM0-x\",\"features_command.md\":\"Byl9YoT7\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"features_grave_esc.md\":\"mUNEjUYS\",\"features_dip_switch.md\":\"DtBOdc98\",\"features_combo.md\":\"C-GfDyXJ\",\"features_autocorrect.md\":\"DHRDcuho\",\"features_repeat_key.md\":\"C3eWDUWn\",\"feature_converters.md\":\"DFKin1io\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"features_encoders.md\":\"B2SX3hG2\",\"changelog_20220827.md\":\"DjPthqDk\",\"hardware_drivers.md\":\"BUnx48D9\",\"features_joystick.md\":\"CW0gZHec\",\"unit_testing.md\":\"u3fgbGUj\",\"features_key_lock.md\":\"IjFq9dYs\",\"features_key_overrides.md\":\"rVTP6kn9\",\"api_development_environment.md\":\"EhJClb9f\",\"features_programmable_button.md\":\"D332w_PT\",\"getting_started_introduction.md\":\"BOJreqSs\",\"getting_started_make_guide.md\":\"BjUuEnSh\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"index.md\":\"B4QYzvHE\",\"keycodes_basic.md\":\"CHIeCvwn\",\"features_swap_hands.md\":\"DOhgGQf9\",\"keycodes_magic.md\":\"CGO3hgMm\",\"features_tri_layer.md\":\"DdnBVinw\",\"keycodes_us_ansi_shifted.md\":\"Cs78SDfM\",\"newbs_building_firmware_configurator.md\":\"yyo-1QDE\",\"squeezing_avr.md\":\"BmcLYKOr\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_led_indicators.md\":\"CCZhjHe9\",\"changelog_20230827.md\":\"NSPhmB6l\",\"features_pointing_device.md\":\"DP6-XwL6\",\"feature_macros.md\":\"By1M5R8G\",\"hand_wire.md\":\"CcI1spCv\",\"newbs_building_firmware.md\":\"DnVUK9it\",\"features_rawhid.md\":\"bKKG3KCa\",\"isp_flashing_guide.md\":\"
</body>
</html>