Skip to content

Commit

Permalink
fixup! docs: Add wired split config docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
petejohanson committed Feb 20, 2025
1 parent 6f8707f commit e464646
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
10 changes: 3 additions & 7 deletions docs/docs/config/split.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ Following bluetooth [split keyboard](../features/split-keyboards.md) settings ar

### Wired Splits

Following wired [split keyboard](../features/split-keyboards.md) settings are defined in [zmk/app/src/split/wired/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/split/wired/Kconfig).

:::note

Hardware UARTs have a few different modes/approaches to sending and receiving data, with different levels of complexity and performance. Not all hardware nor drivers support all modes, so ZMK has code to support different interaction modes with the UART as needed. The default mode should be properly selected based on the platform's report support, but you can choose to override the mode if needed.

- Polling Mode - The least efficient mode, this requires the MCU to constantly poll the UART to see if more data has been received, taking time away from other processing. This is basic mode supported by all UART drivers.
Expand All @@ -51,14 +47,14 @@ Hardware UARTs have a few different modes/approaches to sending and receiving da
- SAM0 (e.g. SAMD21)
- STM32 (e.g. stm32f072)

:::
Following wired [split keyboard](../features/split-keyboards.md) settings are defined in [zmk/app/src/split/wired/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/split/wired/Kconfig).

| Config | Type | Description | Default |
| -------------------------------------------- | ---- | ----------------------------------------------------------------- | ------------------------------------------------------------- |
| `CONFIG_ZMK_SPLIT_WIRED` | bool | Use wired connection to communicate between split keyboard halves | y (if no BLE split and devicetree is set appropriately) |
| `CONFIG_ZMK_SPLIT_WIRED_UART_MODE_ASYNC` | bool | Async (DMA) mode | y if the driver supports it (excluding nRF52 with known bugs) |
| `CONFIG_ZMK_SPLIT_WIRED_UART_MODE_INTERRUPT` | bool | Interrupt mode | y if the hardware supports it |
| `CONFIG_ZMK_SPLIT_WIRED_UART_MODE_POLLING` | bool | Polling mode | y it neither other mode is supported |
| `CONFIG_ZMK_SPLIT_WIRED_UART_MODE_INTERRUPT` | bool | Interrupt mode | y if the hardware supports it |
| `CONFIG_ZMK_SPLIT_WIRED_UART_MODE_POLLING` | bool | Polling mode | y it neither other mode is supported |

#### Async (DMA) Mode

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/development/hardware-integration/new-shield.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -522,8 +522,8 @@ If testing the experimental [wired split](../../features/split-keyboards.md) sup
```dts
/ {
wired_split {
compatible = "zmk,wired-split";
device = <&pro_micro_serial>;
compatible = "zmk,wired-split";
device = <&pro_micro_serial>;
};
};
```
Expand Down

0 comments on commit e464646

Please sign in to comment.