feat(split): Runtime selection of split transport (#2886)

feat(split): Runtime selection of split transport

Allow building multiple split transports, and select an active
one based on the transport availability. Wired split availability
depends on additional `detect-gpios` which must be a GPIO pin
that goes active when a wired connection is present.

feat(split): Suspend/resume wired UART devices.

To better support runtime split support, suspend/resume the UART
as necessary to save power when not using the UART.

docs(split): Document adjusting nRF52 UART interrupt priorities

For wired split on nRF52, you may need to adjust the priority for UART
interrupts lower, to ensure the interrupts used for timing sensitive
BT operations can run when needed, so document this in our pinctrl docs.

refactor(split): Restore use of aync UART on nRF52.

With fixes for Zephyr UART driver, re-enable using async API on nRF52.

fix(split): Minor wired split fixes.

Various minor fixes for wired split to avoid spurious TX in half duplex,
etc.

fix: Unconditionally define HID payloads to avoid error.

Don't conditionally define HID indicator payload, to avoid compilation
errors.

docs(split): Expand on details of split transports.

Expand the split keyboard documentation with a more fleshed out section
on the available split trasnports, and what is and isn't supported by
each, including the runtime selection functionality.

---------

Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>
This commit is contained in:
Pete Johanson 2025-06-16 01:45:25 -06:00 committed by GitHub
parent 462d48b78e
commit 6b44d33db2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
22 changed files with 830 additions and 93 deletions

View file

@ -21,9 +21,7 @@
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
// TODO: Active transport selection
struct zmk_split_transport_central *active_transport;
const struct zmk_split_transport_central *active_transport;
#if IS_ENABLED(CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING)
@ -165,10 +163,65 @@ int zmk_split_central_get_peripheral_battery_level(uint8_t source, uint8_t *leve
#endif // IS_ENABLED(CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING)
static int central_init(void) {
STRUCT_SECTION_GET(zmk_split_transport_central, 0, &active_transport);
static int select_first_available_transport(void) {
// Transports are sorted by priority, so find the first
// One that's available, and enable it. Any transport that
// Doesn't support `get_status` is assumed to be always
// available and fully connected.
STRUCT_SECTION_FOREACH(zmk_split_transport_central, t) {
if (!t->api->get_status || t->api->get_status().available) {
if (active_transport == t) {
LOG_DBG("First available is already selected, moving on");
return 0;
}
if (active_transport && active_transport->api->set_enabled) {
int err = active_transport->api->set_enabled(false);
if (err < 0) {
LOG_WRN("Error disabling previously selected split transport (%d)", err);
}
}
active_transport = t;
int err = 0;
if (active_transport->api->set_enabled) {
err = active_transport->api->set_enabled(true);
}
return err;
}
}
return -ENODEV;
}
static int transport_status_changed_cb(const struct zmk_split_transport_central *central,
struct zmk_split_transport_status status) {
if (central == active_transport) {
LOG_DBG("Central at %p changed status: enabled %d, available %d, connections %d", central,
status.enabled, status.available, status.connections);
if (status.connections == ZMK_SPLIT_TRANSPORT_CONNECTIONS_STATUS_DISCONNECTED) {
return select_first_available_transport();
}
} else {
// Just to be sure, in case a higher priority transport becomes available
select_first_available_transport();
}
return 0;
}
static int central_init(void) {
STRUCT_SECTION_FOREACH(zmk_split_transport_central, t) {
if (!t->api->set_status_callback) {
continue;
}
t->api->set_status_callback(transport_status_changed_cb);
}
return select_first_available_transport();
}
SYS_INIT(central_init, APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT);