aboutsummaryrefslogtreecommitdiff
path: root/docs/drivers/uart.md
diff options
context:
space:
mode:
authorRyan <[email protected]>2024-11-15 05:00:02 +1100
committerGitHub <[email protected]>2024-11-14 18:00:02 +0000
commit46236ce3de8385f27e3f13a9921abee7e1e0fa57 (patch)
tree0d5dfc4c40f2b590de0d493324a308d488bda02a /docs/drivers/uart.md
parenta8a47c40114c72a042516c1f93384f228685eb3e (diff)
downloadqmk_firmware-46236ce3de8385f27e3f13a9921abee7e1e0fa57.tar.gz
qmk_firmware-46236ce3de8385f27e3f13a9921abee7e1e0fa57.zip
[docs] Improve halconf/mcuconf code examples (#24597)
Diffstat (limited to 'docs/drivers/uart.md')
-rw-r--r--docs/drivers/uart.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/drivers/uart.md b/docs/drivers/uart.md
index 23f5b3d6e4..7cc68727ee 100644
--- a/docs/drivers/uart.md
+++ b/docs/drivers/uart.md
@@ -35,8 +35,12 @@ You'll need to determine which pins can be used for UART -- as an example, STM32
To enable UART, modify your board's `mcuconf.h` to enable the peripheral you've chosen, for example:
```c
-#undef STM32_SERIAL_USE_USART2
-#define STM32_SERIAL_USE_USART2 TRUE
+#pragma once
+
+#include_next <mcuconf.h>
+
+#undef STM32_SERIAL_USE_USART2 // [!code focus]
+#define STM32_SERIAL_USE_USART2 TRUE // [!code focus]
```
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.