aboutsummaryrefslogtreecommitdiff
path: root/docs/uart_driver.md
diff options
context:
space:
mode:
authorRyan <[email protected]>2023-10-13 17:25:32 +1100
committerGitHub <[email protected]>2023-10-13 17:25:32 +1100
commitc157c19b81fbd8b516de0eb5e854d278669cff1a (patch)
treec2670f9b71cbe95154126018683345afe5890b2c /docs/uart_driver.md
parentf150258e5ab6bf04c2e724389465f7a8ef5759ef (diff)
downloadqmk_firmware-c157c19b81fbd8b516de0eb5e854d278669cff1a.tar.gz
qmk_firmware-c157c19b81fbd8b516de0eb5e854d278669cff1a.zip
Dedupe I2C, SPI, UART driver inclusions (#22253)
Diffstat (limited to 'docs/uart_driver.md')
-rw-r--r--docs/uart_driver.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/uart_driver.md b/docs/uart_driver.md
index a44f2c28d9..a88278d543 100644
--- a/docs/uart_driver.md
+++ b/docs/uart_driver.md
@@ -4,6 +4,18 @@ The UART drivers used in QMK have a set of common functions to allow portability
Currently, this driver does not support enabling hardware flow control (the `RTS` and `CTS` pins) if available, but may do so in future.
+## Usage :id=usage
+
+In most cases, the UART driver code is automatically included if you are using a feature or driver which requires it.
+
+However, if you need to use the driver standalone, add the following to your `rules.mk`:
+
+```make
+UART_DRIVER_REQUIRED = yes
+```
+
+You can then call the UART API by including `uart.h` in your code.
+
## AVR Configuration :id=avr-configuration
No special setup is required - just connect the `RX` and `TX` pins of your UART device to the opposite pins on the MCU: