diff options
| author | François Magimel <magimel.francois@gmail.com> | 2025-09-09 23:51:13 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-09 14:51:13 -0700 |
| commit | 09ab67c0440d8e5e3faf832d23eb1b754845a573 (patch) | |
| tree | 0edccafc937149afdc8b964004f61fe80942cfa2 /docs/drivers | |
| parent | 7be4540b4688eab74920eb4cb2347af43fb6a779 (diff) | |
docs: fix misspellings (#25555)
* docs: fix misspellings
* docs: do line breaks with HTML instead of spaces
To remove trailing spaces and to avoid breaking things, line breaks can
be done with the HTML br tag.
Diffstat (limited to 'docs/drivers')
| -rw-r--r-- | docs/drivers/serial.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/drivers/serial.md b/docs/drivers/serial.md index dda75f629a..2c78f59043 100644 --- a/docs/drivers/serial.md +++ b/docs/drivers/serial.md | |||
| @@ -33,7 +33,7 @@ On ARM platforms the bitbang driver causes connection issues when using it toget | |||
| 33 | +-------+ +-------+ | 33 | +-------+ +-------+ |
| 34 | ``` | 34 | ``` |
| 35 | 35 | ||
| 36 | One GPIO pin is needed for the bitbang driver, as only one wire is used for receiving and transmitting data. This pin is referred to as the `SOFT_SERIAL_PIN` (SSP) in the configuration. A TRS or USB cable provides enough conductors for this driver to function. | 36 | One GPIO pin is needed for the bitbang driver, as only one wire is used for receiving and transmitting data. This pin is referred to as the `SOFT_SERIAL_PIN` (SSP) in the configuration. A TRS or USB cable provides enough conductors for this driver to function. |
| 37 | 37 | ||
| 38 | ### Setup | 38 | ### Setup |
| 39 | 39 | ||
| @@ -63,12 +63,12 @@ SERIAL_DRIVER = bitbang | |||
| 63 | 63 | ||
| 64 | ## USART Half-duplex | 64 | ## USART Half-duplex |
| 65 | 65 | ||
| 66 | Targeting ARM boards based on ChibiOS, where communication is offloaded to a USART hardware device that supports Half-duplex operation. The advantages over bitbanging are fast, accurate timings and reduced CPU usage. Therefore it is advised to choose Half-duplex over Bitbang if MCU is capable of utilising Half-duplex, and Full-duplex can't be used instead (e.g. lack of available GPIO pins, or imcompatible PCB design). | 66 | Targeting ARM boards based on ChibiOS, where communication is offloaded to a USART hardware device that supports Half-duplex operation. The advantages over bitbanging are fast, accurate timings and reduced CPU usage. Therefore it is advised to choose Half-duplex over Bitbang if MCU is capable of utilising Half-duplex, and Full-duplex can't be used instead (e.g. lack of available GPIO pins, or incompatible PCB design). |
| 67 | 67 | ||
| 68 | ### Pin configuration | 68 | ### Pin configuration |
| 69 | 69 | ||
| 70 | ``` | 70 | ``` |
| 71 | LEFT RIGHT | 71 | LEFT RIGHT |
| 72 | +-------+ | | +-------+ | 72 | +-------+ | | +-------+ |
| 73 | | | R R | | | 73 | | | R R | | |
| 74 | | | | SERIAL | | | | 74 | | | | SERIAL | | | |
| @@ -80,7 +80,7 @@ Targeting ARM boards based on ChibiOS, where communication is offloaded to a USA | |||
| 80 | +-------+ +-------+ | 80 | +-------+ +-------+ |
| 81 | ``` | 81 | ``` |
| 82 | 82 | ||
| 83 | Only one GPIO pin is needed for the Half-duplex driver, as only one wire is used for receiving and transmitting data. This pin is referred to as the `SERIAL_USART_TX_PIN` in the configuration. Ensure that the pin chosen for split communication can operate as the TX pin of the contoller's USART peripheral. A TRS or USB cable provides enough conductors for this driver to function. As the split connection is configured to operate in open-drain mode, an **external pull-up resistor is needed to keep the line high**. Resistor values of 1.5kΩ to 8.2kΩ are known to work. | 83 | Only one GPIO pin is needed for the Half-duplex driver, as only one wire is used for receiving and transmitting data. This pin is referred to as the `SERIAL_USART_TX_PIN` in the configuration. Ensure that the pin chosen for split communication can operate as the TX pin of the contoller's USART peripheral. A TRS or USB cable provides enough conductors for this driver to function. As the split connection is configured to operate in open-drain mode, an **external pull-up resistor is needed to keep the line high**. Resistor values of 1.5kΩ to 8.2kΩ are known to work. |
| 84 | 84 | ||
| 85 | ::: warning | 85 | ::: warning |
| 86 | ***Note:*** A pull-up resistor isn't required for RP2040 controllers configured with PIO subsystem. | 86 | ***Note:*** A pull-up resistor isn't required for RP2040 controllers configured with PIO subsystem. |
| @@ -278,7 +278,7 @@ There are several advanced configuration options that can be defined in your key | |||
| 278 | 278 | ||
| 279 | ### Baudrate | 279 | ### Baudrate |
| 280 | 280 | ||
| 281 | If you're having issues or need a higher baudrate with serial communication, you can change the baudrate which in turn controls the communication speed for serial. You want to lower the baudrate if you experience failed transactions. | 281 | If you're having issues or need a higher baudrate with serial communication, you can change the baudrate which in turn controls the communication speed for serial. You want to lower the baudrate if you experience failed transactions. |
| 282 | 282 | ||
| 283 | ```c | 283 | ```c |
| 284 | #define SELECT_SOFT_SERIAL_SPEED n | 284 | #define SELECT_SOFT_SERIAL_SPEED n |
| @@ -307,19 +307,19 @@ This is the default time window in milliseconds in which a successful communicat | |||
| 307 | 307 | ||
| 308 | ## Troubleshooting | 308 | ## Troubleshooting |
| 309 | 309 | ||
| 310 | If you're having issues withe serial communication, you can enable debug messages that will give you insights which part of the communication failed. The enable these messages add to your keyboards `config.h` file: | 310 | If you're having issues with serial communication, you can enable debug messages that will give you insights which part of the communication failed. The enable these messages add to your keyboards `config.h` file: |
| 311 | 311 | ||
| 312 | ```c | 312 | ```c |
| 313 | #define SERIAL_DEBUG | 313 | #define SERIAL_DEBUG |
| 314 | ``` | 314 | ``` |
| 315 | 315 | ||
| 316 | ::: tip | 316 | ::: tip |
| 317 | The messages will be printed out to the `CONSOLE` output. For additional information, refer to [Debugging/Troubleshooting QMK](../faq_debug). | 317 | The messages will be printed out to the `CONSOLE` output. For additional information, refer to [Debugging/Troubleshooting QMK](../faq_debug). |
| 318 | ::: | 318 | ::: |
| 319 | 319 | ||
| 320 | ## Alternate Functions for selected STM32 MCUs | 320 | ## Alternate Functions for selected STM32 MCUs |
| 321 | 321 | ||
| 322 | Pins for USART Peripherals with | 322 | Pins for USART Peripherals with |
| 323 | 323 | ||
| 324 | ### STM32F303 / Proton-C [Datasheet](https://www.st.com/resource/en/datasheet/stm32f303cc.pdf) | 324 | ### STM32F303 / Proton-C [Datasheet](https://www.st.com/resource/en/datasheet/stm32f303cc.pdf) |
| 325 | 325 | ||
